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
+33-5Lines changed: 33 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -3774,6 +3774,7 @@ components:
3774
3774
email:
3775
3775
type: string
3776
3776
description: The email address of the user who submitted the Feedback.event.MANUAL_FEEDBACK event.
3777
+
deprecated: true
3777
3778
source:
3778
3779
type: string
3779
3780
description: The source associated with the Feedback.event.MANUAL_FEEDBACK event.
@@ -4366,7 +4367,7 @@ components:
4366
4367
description: Disables automatic adjustment of the input query for spelling corrections or other reasons.
4367
4368
returnLlmContentOverSnippets:
4368
4369
type: boolean
4369
-
description: "[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions."
4370
+
description: Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content.
4370
4371
inclusions:
4371
4372
$ref: "#/components/schemas/RestrictionFilters"
4372
4373
description: A list of filters which restrict the search results to only the specified content.
@@ -4864,6 +4865,9 @@ components:
4864
4865
name:
4865
4866
type: string
4866
4867
description: Name of the group.
4868
+
datasourceInstance:
4869
+
type: string
4870
+
description: Datasource instance if the group belongs to one e.g. external groups.
4867
4871
UserRole:
4868
4872
type: string
4869
4873
description: A user's role with respect to a specific document.
@@ -5841,9 +5845,6 @@ components:
5841
5845
required:
5842
5846
- snippet
5843
5847
properties:
5844
-
snippet:
5845
-
type: string
5846
-
description: A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
5847
5848
mimeType:
5848
5849
type: string
5849
5850
description: The mime type of the snippets, currently either text/plain or text/html.
@@ -5861,6 +5862,10 @@ components:
5861
5862
url:
5862
5863
type: string
5863
5864
description: A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
5865
+
snippet:
5866
+
type: string
5867
+
deprecated: true
5868
+
description: A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead.
5864
5869
example:
5865
5870
snippet: snippet
5866
5871
mimeType: mimeType
@@ -5954,6 +5959,8 @@ components:
5954
5959
- THREAD_ROOT
5955
5960
- PREFIX
5956
5961
- SUFFIX
5962
+
- AUTHOR_PREFIX
5963
+
- AUTHOR_SUFFIX
5957
5964
ClusterGroup:
5958
5965
required:
5959
5966
- visibleCountHint
@@ -7306,7 +7313,7 @@ components:
7306
7313
$ref: "#/components/schemas/AgentConfig"
7307
7314
description: Describes the agent config that generated this message. Populated on responses and not required on requests.
7308
7315
author:
7309
-
default: GLEAN_AI
7316
+
default: USER
7310
7317
enum:
7311
7318
- USER
7312
7319
- GLEAN_AI
@@ -7482,12 +7489,18 @@ components:
7482
7489
description: A historical representation of a series of chat messages a user had with Glean Assistant.
description: Categories of content requested. An allowlist gives flexibility to request content separately or together.
9149
9163
requestOptions:
9150
9164
$ref: "#/components/schemas/FeedRequestOptions"
@@ -9300,6 +9314,14 @@ components:
9300
9314
type: array
9301
9315
items:
9302
9316
$ref: "#/components/schemas/GeneratedAttachment"
9317
+
ChatSuggestion:
9318
+
properties:
9319
+
query:
9320
+
type: string
9321
+
description: The actionable chat query to run when the user selects this suggestion.
9322
+
feature:
9323
+
type: string
9324
+
description: Targeted Glean Chat feature for the suggestion.
9303
9325
PromptTemplateMutableProperties:
9304
9326
required:
9305
9327
- template
@@ -9513,6 +9535,7 @@ components:
9513
9535
- ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION
9514
9536
- ZERO_STATE_STATIC_WORKFLOW_SUGGESTION
9515
9537
- ZERO_STATE_AGENT_SUGGESTION
9538
+
- PERSONALIZED_CHAT_SUGGESTION
9516
9539
description: Type of the justification.
9517
9540
justification:
9518
9541
type: string
@@ -9537,6 +9560,8 @@ components:
9537
9560
$ref: "#/components/schemas/Person"
9538
9561
app:
9539
9562
$ref: "#/components/schemas/AppResult"
9563
+
chatSuggestion:
9564
+
$ref: "#/components/schemas/ChatSuggestion"
9540
9565
promptTemplate:
9541
9566
$ref: "#/components/schemas/PromptTemplateResult"
9542
9567
workflow:
@@ -9578,6 +9603,7 @@ components:
9578
9603
- ZERO_STATE_WORKFLOW_FAVORITES
9579
9604
- ZERO_STATE_WORKFLOW_POPULAR
9580
9605
- ZERO_STATE_WORKFLOW_SUGGESTION
9606
+
- PERSONALIZED_CHAT_SUGGESTION
9581
9607
description: Category of the result, one of the requested categories in incoming request.
9582
9608
primaryEntry:
9583
9609
$ref: "#/components/schemas/FeedEntry"
@@ -11575,6 +11601,7 @@ components:
11575
11601
- EXTERNAL_SHORTCUT
11576
11602
- ENTITY
11577
11603
- CALENDAR
11604
+
- AGENTS
11578
11605
description: The document category of this object type.
11579
11606
propertyDefinitions:
11580
11607
type: array
@@ -11629,6 +11656,7 @@ components:
11629
11656
- EXTERNAL_SHORTCUT
11630
11657
- ENTITY
11631
11658
- CALENDAR
11659
+
- AGENTS
11632
11660
default: UNCATEGORIZED
11633
11661
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.
An asynchronous SDK client is also available that returns a [`CompletableFuture<T>`][comp-fut]. See [Asynchronous Support](#asynchronous-support) for more details on async benefits and reactive library integration.
<!-- Start Asynchronous Support [async-support] -->
233
+
## Asynchronous Support
234
+
235
+
The SDK provides comprehensive asynchronous support using Java's [`CompletableFuture<T>`][comp-fut] and [Reactive Streams `Publisher<T>`][reactive-streams] APIs. This design makes no assumptions about your choice of reactive toolkit, allowing seamless integration with any reactive library.
236
+
237
+
<details>
238
+
<summary>Why Use Async?</summary>
239
+
240
+
Asynchronous operations provide several key benefits:
241
+
242
+
-**Non-blocking I/O**: Your threads stay free for other work while operations are in flight
243
+
-**Better resource utilization**: Handle more concurrent operations with fewer threads
244
+
-**Improved scalability**: Build highly responsive applications that can handle thousands of concurrent requests
245
+
-**Reactive integration**: Works seamlessly with reactive streams and backpressure handling
246
+
247
+
</details>
248
+
249
+
<details>
250
+
<summary>Reactive Library Integration</summary>
251
+
252
+
The SDK returns [Reactive Streams `Publisher<T>`][reactive-streams] instances for operations dealing with streams involving multiple I/O interactions. We use Reactive Streams instead of JDK Flow API to provide broader compatibility with the reactive ecosystem, as most reactive libraries natively support Reactive Streams.
253
+
254
+
**Why Reactive Streams over JDK Flow?**
255
+
-**Broader ecosystem compatibility**: Most reactive libraries (Project Reactor, RxJava, Akka Streams, etc.) natively support Reactive Streams
256
+
-**Industry standard**: Reactive Streams is the de facto standard for reactive programming in Java
257
+
-**Better interoperability**: Seamless integration without additional adapters for most use cases
258
+
259
+
**Integration with Popular Libraries:**
260
+
-**Project Reactor**: Use `Flux.from(publisher)` to convert to Reactor types
261
+
-**RxJava**: Use `Flowable.fromPublisher(publisher)` for RxJava integration
262
+
-**Akka Streams**: Use `Source.fromPublisher(publisher)` for Akka Streams integration
263
+
-**Vert.x**: Use `ReadStream.fromPublisher(vertx, publisher)` for Vert.x reactive streams
264
+
-**Mutiny**: Use `Multi.createFrom().publisher(publisher)` for Quarkus Mutiny integration
265
+
266
+
**For JDK Flow API Integration:**
267
+
If you need JDK Flow API compatibility (e.g., for Quarkus/Mutiny 2), you can use adapters:
268
+
```java
269
+
// Convert Reactive Streams Publisher to Flow Publisher
0 commit comments