diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 8cf54228..a1456ffa 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 664aaca5-a41f-4434-8f2a-642dba92fe68 management: - docChecksum: bb65a174a6b697994f7bde3845843d9d + docChecksum: 187eb1271d8228d58d3f867fe7532643 docVersion: 0.9.0 speakeasyVersion: 1.551.0 generationVersion: 2.610.0 - releaseVersion: 0.8.1 - configChecksum: 0bad2f357063106341602207cf43f47b + releaseVersion: 0.9.1 + configChecksum: efec76ea16f25a22515ea96f1d881dea repoURL: https://github.com/gleanwork/api-client-typescript.git installationURL: https://github.com/gleanwork/api-client-typescript published: true @@ -390,6 +390,10 @@ generatedFiles: - docs/models/components/listshortcutspaginatedresponse.md - docs/models/components/manualfeedbackinfo.md - docs/models/components/manualfeedbackinfosource.md + - docs/models/components/manualfeedbackinfovote.md + - docs/models/components/manualfeedbacksidebysideinfo.md + - docs/models/components/manualfeedbacksidebysideinfosource.md + - docs/models/components/manualfeedbacksidebysideinfovote.md - docs/models/components/meeting.md - docs/models/components/message.md - docs/models/components/messagesrequest.md @@ -456,6 +460,7 @@ generatedFiles: - docs/models/components/reportstatusresponsestatus.md - docs/models/components/requesttype.md - docs/models/components/responsehint.md + - docs/models/components/responsemetadata.md - docs/models/components/responsestatus.md - docs/models/components/restrictionfilters.md - docs/models/components/resultdocument.md @@ -493,6 +498,7 @@ generatedFiles: - docs/models/components/shortcutinsightsresponse.md - docs/models/components/shortcutmutableproperties.md - docs/models/components/shortcutspaginationmetadata.md + - docs/models/components/sidebysideimplementation.md - docs/models/components/socialnetwork.md - docs/models/components/socialnetworkdefinition.md - docs/models/components/sortoptions.md @@ -568,7 +574,6 @@ generatedFiles: - docs/models/components/verifyrequest.md - docs/models/components/verifyrequestaction.md - docs/models/components/viewerinfo.md - - docs/models/components/vote.md - docs/models/components/warningtype.md - docs/models/components/workflow.md - docs/models/components/workflowfeedbackinfo.md @@ -1039,6 +1044,7 @@ generatedFiles: - src/__tests__/mockserver/internal/sdk/models/components/listshortcutspaginatedrequest.go - src/__tests__/mockserver/internal/sdk/models/components/listshortcutspaginatedresponse.go - src/__tests__/mockserver/internal/sdk/models/components/manualfeedbackinfo.go + - src/__tests__/mockserver/internal/sdk/models/components/manualfeedbacksidebysideinfo.go - src/__tests__/mockserver/internal/sdk/models/components/meeting.go - src/__tests__/mockserver/internal/sdk/models/components/message.go - src/__tests__/mockserver/internal/sdk/models/components/messagesrequest.go @@ -1117,6 +1123,7 @@ generatedFiles: - src/__tests__/mockserver/internal/sdk/models/components/shortcutinsightsresponse.go - src/__tests__/mockserver/internal/sdk/models/components/shortcutmutableproperties.go - src/__tests__/mockserver/internal/sdk/models/components/shortcutspaginationmetadata.go + - src/__tests__/mockserver/internal/sdk/models/components/sidebysideimplementation.go - src/__tests__/mockserver/internal/sdk/models/components/socialnetwork.go - src/__tests__/mockserver/internal/sdk/models/components/socialnetworkdefinition.go - src/__tests__/mockserver/internal/sdk/models/components/sortoptions.go @@ -1718,6 +1725,7 @@ generatedFiles: - src/models/components/listshortcutspaginatedrequest.ts - src/models/components/listshortcutspaginatedresponse.ts - src/models/components/manualfeedbackinfo.ts + - src/models/components/manualfeedbacksidebysideinfo.ts - src/models/components/meeting.ts - src/models/components/message.ts - src/models/components/messagesrequest.ts @@ -1796,6 +1804,7 @@ generatedFiles: - src/models/components/shortcutinsightsresponse.ts - src/models/components/shortcutmutableproperties.ts - src/models/components/shortcutspaginationmetadata.ts + - src/models/components/sidebysideimplementation.ts - src/models/components/socialnetwork.ts - src/models/components/socialnetworkdefinition.ts - src/models/components/sortoptions.ts diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 69f1d12c..79047d7b 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -25,7 +25,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: true typescript: - version: 0.8.1 + version: 0.9.1 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/glean-merged-spec.yaml b/.speakeasy/glean-merged-spec.yaml index e41f9253..e1b60684 100644 --- a/.speakeasy/glean-merged-spec.yaml +++ b/.speakeasy/glean-merged-spec.yaml @@ -2245,7 +2245,7 @@ paths: /api/index/v1/indexdocuments: post: summary: Index documents - description: Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. + description: Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. tags: - Documents requestBody: @@ -2271,7 +2271,7 @@ paths: /api/index/v1/bulkindexdocuments: post: summary: Bulk index documents - description: Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + description: Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. tags: - Documents requestBody: @@ -2403,7 +2403,7 @@ paths: /api/index/v1/bulkindexusers: post: summary: Bulk index users - description: Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + description: Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. tags: - Permissions requestBody: @@ -2451,7 +2451,7 @@ paths: /api/index/v1/bulkindexgroups: post: summary: Bulk index groups - description: Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + description: Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. tags: - Permissions requestBody: @@ -2499,7 +2499,7 @@ paths: /api/index/v1/bulkindexmemberships: post: summary: Bulk index memberships for a group - description: Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + description: Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. tags: - Permissions requestBody: @@ -2622,7 +2622,7 @@ paths: description: | Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. tags: - Troubleshooting parameters: @@ -2653,7 +2653,7 @@ paths: description: | Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. tags: - Troubleshooting parameters: @@ -2691,7 +2691,7 @@ paths: description: | Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. tags: - Troubleshooting parameters: @@ -2729,7 +2729,7 @@ paths: description: | Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. tags: - Troubleshooting parameters: @@ -2765,7 +2765,7 @@ paths: description: | Check if a given user has access to access a document in a custom datasource - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. tags: - Troubleshooting requestBody: @@ -2797,7 +2797,7 @@ paths: description: | Intended for debugging/validation. Fetches the current upload and indexing status of documents. - Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-document) for richer information. + Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. tags: - Troubleshooting requestBody: @@ -2829,7 +2829,7 @@ paths: description: | Fetches document count for the specified custom datasource. - Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. tags: - Troubleshooting requestBody: @@ -2861,7 +2861,7 @@ paths: description: | Fetches user count for the specified custom datasource. - Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. tags: - Troubleshooting requestBody: @@ -2963,7 +2963,7 @@ paths: /api/index/v1/rotatetoken: post: summary: Rotate token - description: Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/docs/indexing_api_token_rotation/) documentation for more information. + description: Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. tags: - Authentication responses: @@ -3006,7 +3006,7 @@ paths: /api/index/v1/bulkindexemployees: post: summary: Bulk index employees - description: Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + description: Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. tags: - People requestBody: @@ -3121,7 +3121,7 @@ paths: /api/index/v1/bulkindexteams: post: summary: Bulk index teams - description: Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + description: Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. tags: - People requestBody: @@ -3868,6 +3868,71 @@ components: ratingScale: type: integer description: The scale of comparison for a rating associated with the feedback. Rating values start from one and go up to the maximum specified by ratingScale. For example, a five-option satisfaction rating will have a ratingScale of 5 and a thumbs-up/thumbs-down rating will have a ratingScale of 2. + SideBySideImplementation: + properties: + implementationId: + type: string + description: Unique identifier for this implementation variant. + implementationName: + type: string + description: Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude"). + searchParams: + type: object + description: The search/chat parameters used for this implementation. + additionalProperties: + type: string + response: + type: string + description: The full response generated by this implementation. + responseMetadata: + type: object + description: Metadata about the response (e.g., latency, token count). + properties: + latencyMs: + type: integer + description: Time taken to generate the response in milliseconds. + tokenCount: + type: integer + description: Number of tokens in the response. + modelUsed: + type: string + description: The specific model version used. + ManualFeedbackSideBySideInfo: + properties: + email: + type: string + description: The email address of the user who submitted the side-by-side feedback. + source: + type: string + description: The source associated with the side-by-side feedback event. + enum: + - LIVE_EVAL + - CHAT + - SEARCH + query: + type: string + description: The query or prompt that was evaluated across multiple implementations. + implementations: + type: array + description: Array of implementations that were compared side-by-side. + items: + $ref: "#/components/schemas/SideBySideImplementation" + evaluationSessionId: + type: string + description: Unique identifier for this evaluation session to group related feedback events. + implementationId: + type: string + description: The ID of the implementation this specific feedback event is for. + vote: + type: string + description: The vote for this specific implementation. + enum: + - UPVOTE + - DOWNVOTE + - NEUTRAL + comments: + type: string + description: Specific feedback comments for this implementation. SeenFeedbackInfo: properties: isExplicit: @@ -3938,6 +4003,7 @@ components: FOCUS_IN: The user clicked into an interactive element, e.g. the search box. LAST_TOKEN: The final token of a streaming response is received. MANUAL_FEEDBACK: The user submitted textual manual feedback regarding the object. + MANUAL_FEEDBACK_SIDE_BY_SIDE: The user submitted comparative feedback for multiple side-by-side implementations. MARK_AS_READ: The user explicitly marked the content as read. MESSAGE: The user attempted to send a message using their default messaing app. MIDDLE_CLICK: The user middle clicked the object's primary link with the intent to open its full representation in a new tab. @@ -3967,6 +4033,7 @@ components: - FOCUS_IN - LAST_TOKEN - MANUAL_FEEDBACK + - MANUAL_FEEDBACK_SIDE_BY_SIDE - MARK_AS_READ - MESSAGE - MIDDLE_CLICK @@ -4021,6 +4088,8 @@ components: description: The UI element associated with the event, if any. manualFeedbackInfo: $ref: "#/components/schemas/ManualFeedbackInfo" + manualFeedbackSideBySideInfo: + $ref: "#/components/schemas/ManualFeedbackSideBySideInfo" seenFeedbackInfo: $ref: "#/components/schemas/SeenFeedbackInfo" userViewInfo: @@ -8441,6 +8510,10 @@ components: searchedQuery: type: string description: The actual query used to perform search and return results. + searchedQueryWithoutNegation: + type: string + description: The query used to perform search and return results, with negated terms and facets removed. + x-includeEmpty: true searchedQueryRanges: type: array items: @@ -10118,7 +10191,7 @@ components: The permalink for viewing the document. **Note: viewURL is a required field if id was not set when uploading the document.**' permissions: $ref: "#/components/schemas/DocumentPermissionsDefinition" - description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/docs/indexing_api_permissions/) for more details. + description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/indexing/documents/permissions) for more details. required: - permissions - datasource @@ -10620,7 +10693,7 @@ components: description: The current owner of the document, if not the author. permissions: $ref: "#/components/schemas/DocumentPermissionsDefinition" - description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/docs/indexing_api_permissions/) for more details. + description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/indexing/documents/permissions) for more details. createdAt: type: integer format: int64 @@ -10654,7 +10727,7 @@ components: type: array items: $ref: "#/components/schemas/CustomProperty" - description: Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/docs/facets_and_operators_for_custom_datasources/). + description: Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). required: - datasource CommentDefinition: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 800560d3..7477992e 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,11 +2,11 @@ speakeasyVersion: 1.551.0 sources: Glean API: sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:57fc6af98e6e9e98c92547985293be8fafd52d2a1d1ef88d4b24636743b9f119 - sourceBlobDigest: sha256:01cf4577ff2f15ba160b16bba410571a8ba0c5fefa7e6dd7101edef7ef7c68dc + sourceRevisionDigest: sha256:75581c4a22fba1f6d474df79d1dd3a7561f5c7572815e177b7a713fbbd68916b + sourceBlobDigest: sha256:56336b5b5f542df8963b8a6ccfb43263a1db3df62afd8ec59fcdd9486906c45c tags: - latest - - speakeasy-sdk-regen-1751974092 + - speakeasy-sdk-regen-1752801744 Glean Client API: sourceNamespace: glean-client-api sourceRevisionDigest: sha256:aec0770b5bcca91068c3a844cb9ef4a091281f6cc3b7d86f2abef1bd6fb2b301 @@ -18,10 +18,10 @@ targets: glean: source: Glean API sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:57fc6af98e6e9e98c92547985293be8fafd52d2a1d1ef88d4b24636743b9f119 - sourceBlobDigest: sha256:01cf4577ff2f15ba160b16bba410571a8ba0c5fefa7e6dd7101edef7ef7c68dc + sourceRevisionDigest: sha256:75581c4a22fba1f6d474df79d1dd3a7561f5c7572815e177b7a713fbbd68916b + sourceBlobDigest: sha256:56336b5b5f542df8963b8a6ccfb43263a1db3df62afd8ec59fcdd9486906c45c codeSamplesNamespace: glean-api-specs-typescript-code-samples - codeSamplesRevisionDigest: sha256:bfa1fe67ed2cd904cb271440267bc7448068708da557131ee5bdab2cd50a6f46 + codeSamplesRevisionDigest: sha256:c3f9cbd5d83c48dadacae13d8b3e7842339968f6f84312b2b134d9b33bdc9c42 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 53e2948f..a8dc14a5 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -238,4 +238,14 @@ Based on: ### Generated - [typescript v0.8.1] . ### Releases -- [NPM v0.8.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.8.1 - . \ No newline at end of file +- [NPM v0.8.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.8.1 - . + +## 2025-07-22 00:00:02 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.551.0 (2.610.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.9.1] . +### Releases +- [NPM v0.9.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.9.1 - . \ No newline at end of file diff --git a/docs/models/components/documentdefinition.md b/docs/models/components/documentdefinition.md index a5b7da93..f4251dc8 100644 --- a/docs/models/components/documentdefinition.md +++ b/docs/models/components/documentdefinition.md @@ -38,4 +38,4 @@ let value: DocumentDefinition = { | `status` | *string* | :heavy_minus_sign: | N/A | | `additionalUrls` | *string*[] | :heavy_minus_sign: | Additional variations of the URL that this document points to. | | `comments` | [components.CommentDefinition](../../models/components/commentdefinition.md)[] | :heavy_minus_sign: | Comments associated with the document. | -| `customProperties` | [components.CustomProperty](../../models/components/customproperty.md)[] | :heavy_minus_sign: | Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/docs/facets_and_operators_for_custom_datasources/). | \ No newline at end of file +| `customProperties` | [components.CustomProperty](../../models/components/customproperty.md)[] | :heavy_minus_sign: | Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). | \ No newline at end of file diff --git a/docs/models/components/event.md b/docs/models/components/event.md index 6d0555bb..9c15e22e 100644 --- a/docs/models/components/event.md +++ b/docs/models/components/event.md @@ -13,5 +13,5 @@ let value: Event = "COPY_LINK"; ## Values ```typescript -"CLICK" | "CONTAINER_CLICK" | "COPY_LINK" | "CREATE" | "DISMISS" | "DOWNVOTE" | "EMAIL" | "EXECUTE" | "FILTER" | "FIRST_TOKEN" | "FOCUS_IN" | "LAST_TOKEN" | "MANUAL_FEEDBACK" | "MARK_AS_READ" | "MESSAGE" | "MIDDLE_CLICK" | "PAGE_BLUR" | "PAGE_FOCUS" | "PAGE_LEAVE" | "PREVIEW" | "RELATED_CLICK" | "RIGHT_CLICK" | "SECTION_CLICK" | "SEEN" | "SHARE" | "SHOW_MORE" | "UPVOTE" | "VIEW" | "VISIBLE" +"CLICK" | "CONTAINER_CLICK" | "COPY_LINK" | "CREATE" | "DISMISS" | "DOWNVOTE" | "EMAIL" | "EXECUTE" | "FILTER" | "FIRST_TOKEN" | "FOCUS_IN" | "LAST_TOKEN" | "MANUAL_FEEDBACK" | "MANUAL_FEEDBACK_SIDE_BY_SIDE" | "MARK_AS_READ" | "MESSAGE" | "MIDDLE_CLICK" | "PAGE_BLUR" | "PAGE_FOCUS" | "PAGE_LEAVE" | "PREVIEW" | "RELATED_CLICK" | "RIGHT_CLICK" | "SECTION_CLICK" | "SEEN" | "SHARE" | "SHOW_MORE" | "UPVOTE" | "VIEW" | "VISIBLE" ``` \ No newline at end of file diff --git a/docs/models/components/feedback.md b/docs/models/components/feedback.md index ae64f6cd..2631929f 100644 --- a/docs/models/components/feedback.md +++ b/docs/models/components/feedback.md @@ -32,6 +32,7 @@ let value: Feedback = { | `uiTree` | *string*[] | :heavy_minus_sign: | The UI element tree associated with the event, if any. | | `uiElement` | *string* | :heavy_minus_sign: | The UI element associated with the event, if any. | | `manualFeedbackInfo` | [components.ManualFeedbackInfo](../../models/components/manualfeedbackinfo.md) | :heavy_minus_sign: | N/A | +| `manualFeedbackSideBySideInfo` | [components.ManualFeedbackSideBySideInfo](../../models/components/manualfeedbacksidebysideinfo.md) | :heavy_minus_sign: | N/A | | `seenFeedbackInfo` | [components.SeenFeedbackInfo](../../models/components/seenfeedbackinfo.md) | :heavy_minus_sign: | N/A | | `userViewInfo` | [components.UserViewInfo](../../models/components/userviewinfo.md) | :heavy_minus_sign: | N/A | | `workflowFeedbackInfo` | [components.WorkflowFeedbackInfo](../../models/components/workflowfeedbackinfo.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/components/manualfeedbackinfo.md b/docs/models/components/manualfeedbackinfo.md index 208d4185..b823463d 100644 --- a/docs/models/components/manualfeedbackinfo.md +++ b/docs/models/components/manualfeedbackinfo.md @@ -25,7 +25,7 @@ let value: ManualFeedbackInfo = {}; | `previousMessages` | *string*[] | :heavy_minus_sign: | The array of previous messages in a chat session, ordered by oldest to newest. | | `chatTranscript` | [components.FeedbackChatExchange](../../models/components/feedbackchatexchange.md)[] | :heavy_minus_sign: | Array of previous request/response exchanges, ordered by oldest to newest. | | `numQueriesFromFirstRun` | *number* | :heavy_minus_sign: | How many times this query has been run in the past. | -| `vote` | [components.Vote](../../models/components/vote.md) | :heavy_minus_sign: | The vote associated with the Feedback.event.MANUAL_FEEDBACK event. | +| `vote` | [components.ManualFeedbackInfoVote](../../models/components/manualfeedbackinfovote.md) | :heavy_minus_sign: | The vote associated with the Feedback.event.MANUAL_FEEDBACK event. | | `rating` | *number* | :heavy_minus_sign: | A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive. | | `ratingKey` | *string* | :heavy_minus_sign: | A description of the rating that contextualizes how it appeared to the user, e.g. "satisfied". | | `ratingScale` | *number* | :heavy_minus_sign: | The scale of comparison for a rating associated with the feedback. Rating values start from one and go up to the maximum specified by ratingScale. For example, a five-option satisfaction rating will have a ratingScale of 5 and a thumbs-up/thumbs-down rating will have a ratingScale of 2. | \ No newline at end of file diff --git a/docs/models/components/vote.md b/docs/models/components/manualfeedbackinfovote.md similarity index 50% rename from docs/models/components/vote.md rename to docs/models/components/manualfeedbackinfovote.md index a2635c1c..60f8ae52 100644 --- a/docs/models/components/vote.md +++ b/docs/models/components/manualfeedbackinfovote.md @@ -1,13 +1,13 @@ -# Vote +# ManualFeedbackInfoVote The vote associated with the Feedback.event.MANUAL_FEEDBACK event. ## Example Usage ```typescript -import { Vote } from "@gleanwork/api-client/models/components"; +import { ManualFeedbackInfoVote } from "@gleanwork/api-client/models/components"; -let value: Vote = "DOWNVOTE"; +let value: ManualFeedbackInfoVote = "DOWNVOTE"; ``` ## Values diff --git a/docs/models/components/manualfeedbacksidebysideinfo.md b/docs/models/components/manualfeedbacksidebysideinfo.md new file mode 100644 index 00000000..dbbbb670 --- /dev/null +++ b/docs/models/components/manualfeedbacksidebysideinfo.md @@ -0,0 +1,22 @@ +# ManualFeedbackSideBySideInfo + +## Example Usage + +```typescript +import { ManualFeedbackSideBySideInfo } from "@gleanwork/api-client/models/components"; + +let value: ManualFeedbackSideBySideInfo = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `email` | *string* | :heavy_minus_sign: | The email address of the user who submitted the side-by-side feedback. | +| `source` | [components.ManualFeedbackSideBySideInfoSource](../../models/components/manualfeedbacksidebysideinfosource.md) | :heavy_minus_sign: | The source associated with the side-by-side feedback event. | +| `query` | *string* | :heavy_minus_sign: | The query or prompt that was evaluated across multiple implementations. | +| `implementations` | [components.SideBySideImplementation](../../models/components/sidebysideimplementation.md)[] | :heavy_minus_sign: | Array of implementations that were compared side-by-side. | +| `evaluationSessionId` | *string* | :heavy_minus_sign: | Unique identifier for this evaluation session to group related feedback events. | +| `implementationId` | *string* | :heavy_minus_sign: | The ID of the implementation this specific feedback event is for. | +| `vote` | [components.ManualFeedbackSideBySideInfoVote](../../models/components/manualfeedbacksidebysideinfovote.md) | :heavy_minus_sign: | The vote for this specific implementation. | +| `comments` | *string* | :heavy_minus_sign: | Specific feedback comments for this implementation. | \ No newline at end of file diff --git a/docs/models/components/manualfeedbacksidebysideinfosource.md b/docs/models/components/manualfeedbacksidebysideinfosource.md new file mode 100644 index 00000000..065c269b --- /dev/null +++ b/docs/models/components/manualfeedbacksidebysideinfosource.md @@ -0,0 +1,17 @@ +# ManualFeedbackSideBySideInfoSource + +The source associated with the side-by-side feedback event. + +## Example Usage + +```typescript +import { ManualFeedbackSideBySideInfoSource } from "@gleanwork/api-client/models/components"; + +let value: ManualFeedbackSideBySideInfoSource = "LIVE_EVAL"; +``` + +## Values + +```typescript +"LIVE_EVAL" | "CHAT" | "SEARCH" +``` \ No newline at end of file diff --git a/docs/models/components/manualfeedbacksidebysideinfovote.md b/docs/models/components/manualfeedbacksidebysideinfovote.md new file mode 100644 index 00000000..474fffff --- /dev/null +++ b/docs/models/components/manualfeedbacksidebysideinfovote.md @@ -0,0 +1,17 @@ +# ManualFeedbackSideBySideInfoVote + +The vote for this specific implementation. + +## Example Usage + +```typescript +import { ManualFeedbackSideBySideInfoVote } from "@gleanwork/api-client/models/components"; + +let value: ManualFeedbackSideBySideInfoVote = "NEUTRAL"; +``` + +## Values + +```typescript +"UPVOTE" | "DOWNVOTE" | "NEUTRAL" +``` \ No newline at end of file diff --git a/docs/models/components/responsemetadata.md b/docs/models/components/responsemetadata.md new file mode 100644 index 00000000..b103fc4f --- /dev/null +++ b/docs/models/components/responsemetadata.md @@ -0,0 +1,19 @@ +# ResponseMetadata + +Metadata about the response (e.g., latency, token count). + +## Example Usage + +```typescript +import { ResponseMetadata } from "@gleanwork/api-client/models/components"; + +let value: ResponseMetadata = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `latencyMs` | *number* | :heavy_minus_sign: | Time taken to generate the response in milliseconds. | +| `tokenCount` | *number* | :heavy_minus_sign: | Number of tokens in the response. | +| `modelUsed` | *string* | :heavy_minus_sign: | The specific model version used. | \ No newline at end of file diff --git a/docs/models/components/searchresponsemetadata.md b/docs/models/components/searchresponsemetadata.md index cac7cf1b..d08783f2 100644 --- a/docs/models/components/searchresponsemetadata.md +++ b/docs/models/components/searchresponsemetadata.md @@ -66,6 +66,7 @@ let value: SearchResponseMetadata = { | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `rewrittenQuery` | *string* | :heavy_minus_sign: | A cleaned up or updated version of the query to be displayed in the query box. Useful for mapping visual facets to search operators. | | | `searchedQuery` | *string* | :heavy_minus_sign: | The actual query used to perform search and return results. | | +| `searchedQueryWithoutNegation` | *string* | :heavy_minus_sign: | The query used to perform search and return results, with negated terms and facets removed. | | | `searchedQueryRanges` | [components.TextRange](../../models/components/textrange.md)[] | :heavy_minus_sign: | The bolded ranges within the searched query. | | | `originalQuery` | *string* | :heavy_minus_sign: | The query text sent by the client in the request. | | | `querySuggestion` | [components.QuerySuggestion](../../models/components/querysuggestion.md) | :heavy_minus_sign: | N/A | {
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
} | diff --git a/docs/models/components/sidebysideimplementation.md b/docs/models/components/sidebysideimplementation.md new file mode 100644 index 00000000..9708132d --- /dev/null +++ b/docs/models/components/sidebysideimplementation.md @@ -0,0 +1,19 @@ +# SideBySideImplementation + +## Example Usage + +```typescript +import { SideBySideImplementation } from "@gleanwork/api-client/models/components"; + +let value: SideBySideImplementation = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `implementationId` | *string* | :heavy_minus_sign: | Unique identifier for this implementation variant. | +| `implementationName` | *string* | :heavy_minus_sign: | Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude"). | +| `searchParams` | Record | :heavy_minus_sign: | The search/chat parameters used for this implementation. | +| `response` | *string* | :heavy_minus_sign: | The full response generated by this implementation. | +| `responseMetadata` | [components.ResponseMetadata](../../models/components/responsemetadata.md) | :heavy_minus_sign: | Metadata about the response (e.g., latency, token count). | \ No newline at end of file diff --git a/docs/sdks/datasource/README.md b/docs/sdks/datasource/README.md index 6e5adb19..cf31e31d 100644 --- a/docs/sdks/datasource/README.md +++ b/docs/sdks/datasource/README.md @@ -12,7 +12,7 @@ Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. +Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. ### Example Usage diff --git a/docs/sdks/indexingauthentication/README.md b/docs/sdks/indexingauthentication/README.md index daf91549..26d00874 100644 --- a/docs/sdks/indexingauthentication/README.md +++ b/docs/sdks/indexingauthentication/README.md @@ -9,7 +9,7 @@ ## rotateToken -Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/docs/indexing_api_token_rotation/) documentation for more information. +Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. ### Example Usage diff --git a/docs/sdks/indexingdocuments/README.md b/docs/sdks/indexingdocuments/README.md index 7fdef188..bf1d5a57 100644 --- a/docs/sdks/indexingdocuments/README.md +++ b/docs/sdks/indexingdocuments/README.md @@ -115,7 +115,7 @@ import { ## index -Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. +Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. ### Example Usage @@ -208,7 +208,7 @@ import { ## bulkIndex -Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. +Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. ### Example Usage @@ -498,7 +498,7 @@ import { Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. +Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. ### Example Usage @@ -597,7 +597,7 @@ import { Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. +Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. ### Example Usage @@ -704,7 +704,7 @@ import { Check if a given user has access to access a document in a custom datasource -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. +Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. ### Example Usage @@ -806,7 +806,7 @@ import { Intended for debugging/validation. Fetches the current upload and indexing status of documents. -Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-document) for richer information. +Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. @@ -908,7 +908,7 @@ import { Fetches document count for the specified custom datasource. -Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. +Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/docs/sdks/people/README.md b/docs/sdks/people/README.md index 57b2ac27..8cc4ee49 100644 --- a/docs/sdks/people/README.md +++ b/docs/sdks/people/README.md @@ -20,7 +20,7 @@ Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. +Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. ### Example Usage @@ -117,7 +117,7 @@ import { Fetches user count for the specified custom datasource. -Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. +Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. @@ -322,7 +322,7 @@ import { ## bulkIndex -Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. +Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. ### Example Usage @@ -881,7 +881,7 @@ import { ## bulkIndexTeams -Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. +Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. ### Example Usage diff --git a/docs/sdks/permissions/README.md b/docs/sdks/permissions/README.md index 18c995b1..2b9063b3 100644 --- a/docs/sdks/permissions/README.md +++ b/docs/sdks/permissions/README.md @@ -212,7 +212,7 @@ import { ## bulkIndexUsers -Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. +Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. ### Example Usage @@ -430,7 +430,7 @@ import { ## bulkIndexGroups -Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. +Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. ### Example Usage @@ -636,7 +636,7 @@ import { ## bulkIndexMemberships -Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. +Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. ### Example Usage diff --git a/jsr.json b/jsr.json index eb185dc6..3bf1e285 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@gleanwork/api-client", - "version": "0.8.1", + "version": "0.9.1", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 5a07c3cc..1bb7866e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@gleanwork/api-client", - "version": "0.8.1", + "version": "0.9.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@gleanwork/api-client", - "version": "0.8.1", + "version": "0.9.1", "devDependencies": { "@eslint/js": "^9.19.0", "@tanstack/react-query": "^5.61.4", diff --git a/package.json b/package.json index a0c820dc..d559aeda 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@gleanwork/api-client", - "version": "0.8.1", + "version": "0.9.1", "author": "Speakeasy", "type": "module", "tshy": { diff --git a/src/__tests__/mockserver/internal/sdk/models/components/documentdefinition.go b/src/__tests__/mockserver/internal/sdk/models/components/documentdefinition.go index d4e073eb..b0bbd077 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/documentdefinition.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/documentdefinition.go @@ -47,7 +47,7 @@ type DocumentDefinition struct { AdditionalUrls []string `json:"additionalUrls,omitempty"` // Comments associated with the document. Comments []CommentDefinition `json:"comments,omitempty"` - // Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/docs/facets_and_operators_for_custom_datasources/). + // Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). CustomProperties []CustomProperty `json:"customProperties,omitempty"` } diff --git a/src/__tests__/mockserver/internal/sdk/models/components/feedback.go b/src/__tests__/mockserver/internal/sdk/models/components/feedback.go index 101c1f19..a2ba49c8 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/feedback.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/feedback.go @@ -67,35 +67,36 @@ func (e *FeedbackCategory) UnmarshalJSON(data []byte) error { type Event string const ( - EventClick Event = "CLICK" - EventContainerClick Event = "CONTAINER_CLICK" - EventCopyLink Event = "COPY_LINK" - EventCreate Event = "CREATE" - EventDismiss Event = "DISMISS" - EventDownvote Event = "DOWNVOTE" - EventEmail Event = "EMAIL" - EventExecute Event = "EXECUTE" - EventFilter Event = "FILTER" - EventFirstToken Event = "FIRST_TOKEN" - EventFocusIn Event = "FOCUS_IN" - EventLastToken Event = "LAST_TOKEN" - EventManualFeedback Event = "MANUAL_FEEDBACK" - EventMarkAsRead Event = "MARK_AS_READ" - EventMessage Event = "MESSAGE" - EventMiddleClick Event = "MIDDLE_CLICK" - EventPageBlur Event = "PAGE_BLUR" - EventPageFocus Event = "PAGE_FOCUS" - EventPageLeave Event = "PAGE_LEAVE" - EventPreview Event = "PREVIEW" - EventRelatedClick Event = "RELATED_CLICK" - EventRightClick Event = "RIGHT_CLICK" - EventSectionClick Event = "SECTION_CLICK" - EventSeen Event = "SEEN" - EventShare Event = "SHARE" - EventShowMore Event = "SHOW_MORE" - EventUpvote Event = "UPVOTE" - EventView Event = "VIEW" - EventVisible Event = "VISIBLE" + EventClick Event = "CLICK" + EventContainerClick Event = "CONTAINER_CLICK" + EventCopyLink Event = "COPY_LINK" + EventCreate Event = "CREATE" + EventDismiss Event = "DISMISS" + EventDownvote Event = "DOWNVOTE" + EventEmail Event = "EMAIL" + EventExecute Event = "EXECUTE" + EventFilter Event = "FILTER" + EventFirstToken Event = "FIRST_TOKEN" + EventFocusIn Event = "FOCUS_IN" + EventLastToken Event = "LAST_TOKEN" + EventManualFeedback Event = "MANUAL_FEEDBACK" + EventManualFeedbackSideBySide Event = "MANUAL_FEEDBACK_SIDE_BY_SIDE" + EventMarkAsRead Event = "MARK_AS_READ" + EventMessage Event = "MESSAGE" + EventMiddleClick Event = "MIDDLE_CLICK" + EventPageBlur Event = "PAGE_BLUR" + EventPageFocus Event = "PAGE_FOCUS" + EventPageLeave Event = "PAGE_LEAVE" + EventPreview Event = "PREVIEW" + EventRelatedClick Event = "RELATED_CLICK" + EventRightClick Event = "RIGHT_CLICK" + EventSectionClick Event = "SECTION_CLICK" + EventSeen Event = "SEEN" + EventShare Event = "SHARE" + EventShowMore Event = "SHOW_MORE" + EventUpvote Event = "UPVOTE" + EventView Event = "VIEW" + EventVisible Event = "VISIBLE" ) func (e Event) ToPointer() *Event { @@ -133,6 +134,8 @@ func (e *Event) UnmarshalJSON(data []byte) error { fallthrough case "MANUAL_FEEDBACK": fallthrough + case "MANUAL_FEEDBACK_SIDE_BY_SIDE": + fallthrough case "MARK_AS_READ": fallthrough case "MESSAGE": @@ -223,11 +226,12 @@ type Feedback struct { // The UI element tree associated with the event, if any. UITree []string `json:"uiTree,omitempty"` // The UI element associated with the event, if any. - UIElement *string `json:"uiElement,omitempty"` - ManualFeedbackInfo *ManualFeedbackInfo `json:"manualFeedbackInfo,omitempty"` - SeenFeedbackInfo *SeenFeedbackInfo `json:"seenFeedbackInfo,omitempty"` - UserViewInfo *UserViewInfo `json:"userViewInfo,omitempty"` - WorkflowFeedbackInfo *WorkflowFeedbackInfo `json:"workflowFeedbackInfo,omitempty"` + UIElement *string `json:"uiElement,omitempty"` + ManualFeedbackInfo *ManualFeedbackInfo `json:"manualFeedbackInfo,omitempty"` + ManualFeedbackSideBySideInfo *ManualFeedbackSideBySideInfo `json:"manualFeedbackSideBySideInfo,omitempty"` + SeenFeedbackInfo *SeenFeedbackInfo `json:"seenFeedbackInfo,omitempty"` + UserViewInfo *UserViewInfo `json:"userViewInfo,omitempty"` + WorkflowFeedbackInfo *WorkflowFeedbackInfo `json:"workflowFeedbackInfo,omitempty"` // The application ID of the client that sent the feedback event. ApplicationID *string `json:"applicationId,omitempty"` // The agent ID of the client that sent the feedback event. @@ -350,6 +354,13 @@ func (o *Feedback) GetManualFeedbackInfo() *ManualFeedbackInfo { return o.ManualFeedbackInfo } +func (o *Feedback) GetManualFeedbackSideBySideInfo() *ManualFeedbackSideBySideInfo { + if o == nil { + return nil + } + return o.ManualFeedbackSideBySideInfo +} + func (o *Feedback) GetSeenFeedbackInfo() *SeenFeedbackInfo { if o == nil { return nil diff --git a/src/__tests__/mockserver/internal/sdk/models/components/manualfeedbackinfo.go b/src/__tests__/mockserver/internal/sdk/models/components/manualfeedbackinfo.go index 26a64603..642d709e 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/manualfeedbackinfo.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/manualfeedbackinfo.go @@ -138,18 +138,18 @@ func (e *Issue) UnmarshalJSON(data []byte) error { } } -// Vote - The vote associated with the Feedback.event.MANUAL_FEEDBACK event. -type Vote string +// ManualFeedbackInfoVote - The vote associated with the Feedback.event.MANUAL_FEEDBACK event. +type ManualFeedbackInfoVote string const ( - VoteUpvote Vote = "UPVOTE" - VoteDownvote Vote = "DOWNVOTE" + ManualFeedbackInfoVoteUpvote ManualFeedbackInfoVote = "UPVOTE" + ManualFeedbackInfoVoteDownvote ManualFeedbackInfoVote = "DOWNVOTE" ) -func (e Vote) ToPointer() *Vote { +func (e ManualFeedbackInfoVote) ToPointer() *ManualFeedbackInfoVote { return &e } -func (e *Vote) UnmarshalJSON(data []byte) error { +func (e *ManualFeedbackInfoVote) UnmarshalJSON(data []byte) error { var v string if err := json.Unmarshal(data, &v); err != nil { return err @@ -158,10 +158,10 @@ func (e *Vote) UnmarshalJSON(data []byte) error { case "UPVOTE": fallthrough case "DOWNVOTE": - *e = Vote(v) + *e = ManualFeedbackInfoVote(v) return nil default: - return fmt.Errorf("invalid value for Vote: %v", v) + return fmt.Errorf("invalid value for ManualFeedbackInfoVote: %v", v) } } @@ -195,7 +195,7 @@ type ManualFeedbackInfo struct { // How many times this query has been run in the past. NumQueriesFromFirstRun *int64 `json:"numQueriesFromFirstRun,omitempty"` // The vote associated with the Feedback.event.MANUAL_FEEDBACK event. - Vote *Vote `json:"vote,omitempty"` + Vote *ManualFeedbackInfoVote `json:"vote,omitempty"` // A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive. Rating *int64 `json:"rating,omitempty"` // A description of the rating that contextualizes how it appeared to the user, e.g. "satisfied". @@ -295,7 +295,7 @@ func (o *ManualFeedbackInfo) GetNumQueriesFromFirstRun() *int64 { return o.NumQueriesFromFirstRun } -func (o *ManualFeedbackInfo) GetVote() *Vote { +func (o *ManualFeedbackInfo) GetVote() *ManualFeedbackInfoVote { if o == nil { return nil } diff --git a/src/__tests__/mockserver/internal/sdk/models/components/manualfeedbacksidebysideinfo.go b/src/__tests__/mockserver/internal/sdk/models/components/manualfeedbacksidebysideinfo.go new file mode 100644 index 00000000..23fb1a7d --- /dev/null +++ b/src/__tests__/mockserver/internal/sdk/models/components/manualfeedbacksidebysideinfo.go @@ -0,0 +1,143 @@ +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +package components + +import ( + "encoding/json" + "fmt" +) + +// ManualFeedbackSideBySideInfoSource - The source associated with the side-by-side feedback event. +type ManualFeedbackSideBySideInfoSource string + +const ( + ManualFeedbackSideBySideInfoSourceLiveEval ManualFeedbackSideBySideInfoSource = "LIVE_EVAL" + ManualFeedbackSideBySideInfoSourceChat ManualFeedbackSideBySideInfoSource = "CHAT" + ManualFeedbackSideBySideInfoSourceSearch ManualFeedbackSideBySideInfoSource = "SEARCH" +) + +func (e ManualFeedbackSideBySideInfoSource) ToPointer() *ManualFeedbackSideBySideInfoSource { + return &e +} +func (e *ManualFeedbackSideBySideInfoSource) UnmarshalJSON(data []byte) error { + var v string + if err := json.Unmarshal(data, &v); err != nil { + return err + } + switch v { + case "LIVE_EVAL": + fallthrough + case "CHAT": + fallthrough + case "SEARCH": + *e = ManualFeedbackSideBySideInfoSource(v) + return nil + default: + return fmt.Errorf("invalid value for ManualFeedbackSideBySideInfoSource: %v", v) + } +} + +// ManualFeedbackSideBySideInfoVote - The vote for this specific implementation. +type ManualFeedbackSideBySideInfoVote string + +const ( + ManualFeedbackSideBySideInfoVoteUpvote ManualFeedbackSideBySideInfoVote = "UPVOTE" + ManualFeedbackSideBySideInfoVoteDownvote ManualFeedbackSideBySideInfoVote = "DOWNVOTE" + ManualFeedbackSideBySideInfoVoteNeutral ManualFeedbackSideBySideInfoVote = "NEUTRAL" +) + +func (e ManualFeedbackSideBySideInfoVote) ToPointer() *ManualFeedbackSideBySideInfoVote { + return &e +} +func (e *ManualFeedbackSideBySideInfoVote) UnmarshalJSON(data []byte) error { + var v string + if err := json.Unmarshal(data, &v); err != nil { + return err + } + switch v { + case "UPVOTE": + fallthrough + case "DOWNVOTE": + fallthrough + case "NEUTRAL": + *e = ManualFeedbackSideBySideInfoVote(v) + return nil + default: + return fmt.Errorf("invalid value for ManualFeedbackSideBySideInfoVote: %v", v) + } +} + +type ManualFeedbackSideBySideInfo struct { + // The email address of the user who submitted the side-by-side feedback. + Email *string `json:"email,omitempty"` + // The source associated with the side-by-side feedback event. + Source *ManualFeedbackSideBySideInfoSource `json:"source,omitempty"` + // The query or prompt that was evaluated across multiple implementations. + Query *string `json:"query,omitempty"` + // Array of implementations that were compared side-by-side. + Implementations []SideBySideImplementation `json:"implementations,omitempty"` + // Unique identifier for this evaluation session to group related feedback events. + EvaluationSessionID *string `json:"evaluationSessionId,omitempty"` + // The ID of the implementation this specific feedback event is for. + ImplementationID *string `json:"implementationId,omitempty"` + // The vote for this specific implementation. + Vote *ManualFeedbackSideBySideInfoVote `json:"vote,omitempty"` + // Specific feedback comments for this implementation. + Comments *string `json:"comments,omitempty"` +} + +func (o *ManualFeedbackSideBySideInfo) GetEmail() *string { + if o == nil { + return nil + } + return o.Email +} + +func (o *ManualFeedbackSideBySideInfo) GetSource() *ManualFeedbackSideBySideInfoSource { + if o == nil { + return nil + } + return o.Source +} + +func (o *ManualFeedbackSideBySideInfo) GetQuery() *string { + if o == nil { + return nil + } + return o.Query +} + +func (o *ManualFeedbackSideBySideInfo) GetImplementations() []SideBySideImplementation { + if o == nil { + return nil + } + return o.Implementations +} + +func (o *ManualFeedbackSideBySideInfo) GetEvaluationSessionID() *string { + if o == nil { + return nil + } + return o.EvaluationSessionID +} + +func (o *ManualFeedbackSideBySideInfo) GetImplementationID() *string { + if o == nil { + return nil + } + return o.ImplementationID +} + +func (o *ManualFeedbackSideBySideInfo) GetVote() *ManualFeedbackSideBySideInfoVote { + if o == nil { + return nil + } + return o.Vote +} + +func (o *ManualFeedbackSideBySideInfo) GetComments() *string { + if o == nil { + return nil + } + return o.Comments +} diff --git a/src/__tests__/mockserver/internal/sdk/models/components/searchresponsemetadata.go b/src/__tests__/mockserver/internal/sdk/models/components/searchresponsemetadata.go index 0d64b4b3..d8c9a4fb 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/searchresponsemetadata.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/searchresponsemetadata.go @@ -7,6 +7,8 @@ type SearchResponseMetadata struct { RewrittenQuery *string `json:"rewrittenQuery,omitempty"` // The actual query used to perform search and return results. SearchedQuery *string `json:"searchedQuery,omitempty"` + // The query used to perform search and return results, with negated terms and facets removed. + SearchedQueryWithoutNegation *string `json:"searchedQueryWithoutNegation,omitempty"` // The bolded ranges within the searched query. SearchedQueryRanges []TextRange `json:"searchedQueryRanges,omitempty"` // The query text sent by the client in the request. @@ -40,6 +42,13 @@ func (o *SearchResponseMetadata) GetSearchedQuery() *string { return o.SearchedQuery } +func (o *SearchResponseMetadata) GetSearchedQueryWithoutNegation() *string { + if o == nil { + return nil + } + return o.SearchedQueryWithoutNegation +} + func (o *SearchResponseMetadata) GetSearchedQueryRanges() []TextRange { if o == nil { return nil diff --git a/src/__tests__/mockserver/internal/sdk/models/components/sidebysideimplementation.go b/src/__tests__/mockserver/internal/sdk/models/components/sidebysideimplementation.go new file mode 100644 index 00000000..f1cf399e --- /dev/null +++ b/src/__tests__/mockserver/internal/sdk/models/components/sidebysideimplementation.go @@ -0,0 +1,82 @@ +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +package components + +// ResponseMetadata - Metadata about the response (e.g., latency, token count). +type ResponseMetadata struct { + // Time taken to generate the response in milliseconds. + LatencyMs *int64 `json:"latencyMs,omitempty"` + // Number of tokens in the response. + TokenCount *int64 `json:"tokenCount,omitempty"` + // The specific model version used. + ModelUsed *string `json:"modelUsed,omitempty"` +} + +func (o *ResponseMetadata) GetLatencyMs() *int64 { + if o == nil { + return nil + } + return o.LatencyMs +} + +func (o *ResponseMetadata) GetTokenCount() *int64 { + if o == nil { + return nil + } + return o.TokenCount +} + +func (o *ResponseMetadata) GetModelUsed() *string { + if o == nil { + return nil + } + return o.ModelUsed +} + +type SideBySideImplementation struct { + // Unique identifier for this implementation variant. + ImplementationID *string `json:"implementationId,omitempty"` + // Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude"). + ImplementationName *string `json:"implementationName,omitempty"` + // The search/chat parameters used for this implementation. + SearchParams map[string]string `json:"searchParams,omitempty"` + // The full response generated by this implementation. + Response *string `json:"response,omitempty"` + // Metadata about the response (e.g., latency, token count). + ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"` +} + +func (o *SideBySideImplementation) GetImplementationID() *string { + if o == nil { + return nil + } + return o.ImplementationID +} + +func (o *SideBySideImplementation) GetImplementationName() *string { + if o == nil { + return nil + } + return o.ImplementationName +} + +func (o *SideBySideImplementation) GetSearchParams() map[string]string { + if o == nil { + return nil + } + return o.SearchParams +} + +func (o *SideBySideImplementation) GetResponse() *string { + if o == nil { + return nil + } + return o.Response +} + +func (o *SideBySideImplementation) GetResponseMetadata() *ResponseMetadata { + if o == nil { + return nil + } + return o.ResponseMetadata +} diff --git a/src/funcs/indexingAuthenticationRotateToken.ts b/src/funcs/indexingAuthenticationRotateToken.ts index b7658ac2..9dbe9bfe 100644 --- a/src/funcs/indexingAuthenticationRotateToken.ts +++ b/src/funcs/indexingAuthenticationRotateToken.ts @@ -25,7 +25,7 @@ import { Result } from "../types/fp.js"; * Rotate token * * @remarks - * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/docs/indexing_api_token_rotation/) documentation for more information. + * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. */ export function indexingAuthenticationRotateToken( client: GleanCore, diff --git a/src/funcs/indexingDatasourceStatus.ts b/src/funcs/indexingDatasourceStatus.ts index e000565b..c4b29f1e 100644 --- a/src/funcs/indexingDatasourceStatus.ts +++ b/src/funcs/indexingDatasourceStatus.ts @@ -30,7 +30,7 @@ import { Result } from "../types/fp.js"; * @remarks * Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function indexingDatasourceStatus( client: GleanCore, diff --git a/src/funcs/indexingDocumentsBulkIndex.ts b/src/funcs/indexingDocumentsBulkIndex.ts index 2daff8df..43a314ff 100644 --- a/src/funcs/indexingDocumentsBulkIndex.ts +++ b/src/funcs/indexingDocumentsBulkIndex.ts @@ -28,7 +28,7 @@ import { Result } from "../types/fp.js"; * Bulk index documents * * @remarks - * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function indexingDocumentsBulkIndex( client: GleanCore, diff --git a/src/funcs/indexingDocumentsCheckAccess.ts b/src/funcs/indexingDocumentsCheckAccess.ts index 3d2664d0..4c8a1d89 100644 --- a/src/funcs/indexingDocumentsCheckAccess.ts +++ b/src/funcs/indexingDocumentsCheckAccess.ts @@ -29,7 +29,7 @@ import { Result } from "../types/fp.js"; * @remarks * Check if a given user has access to access a document in a custom datasource * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function indexingDocumentsCheckAccess( client: GleanCore, diff --git a/src/funcs/indexingDocumentsCount.ts b/src/funcs/indexingDocumentsCount.ts index 8d0cdcd9..919bab10 100644 --- a/src/funcs/indexingDocumentsCount.ts +++ b/src/funcs/indexingDocumentsCount.ts @@ -29,7 +29,7 @@ import { Result } from "../types/fp.js"; * @remarks * Fetches document count for the specified custom datasource. * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ diff --git a/src/funcs/indexingDocumentsDebug.ts b/src/funcs/indexingDocumentsDebug.ts index 5b2629a2..835058ad 100644 --- a/src/funcs/indexingDocumentsDebug.ts +++ b/src/funcs/indexingDocumentsDebug.ts @@ -30,7 +30,7 @@ import { Result } from "../types/fp.js"; * @remarks * Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function indexingDocumentsDebug( client: GleanCore, diff --git a/src/funcs/indexingDocumentsDebugMany.ts b/src/funcs/indexingDocumentsDebugMany.ts index 6f3e8439..f92064ed 100644 --- a/src/funcs/indexingDocumentsDebugMany.ts +++ b/src/funcs/indexingDocumentsDebugMany.ts @@ -30,7 +30,7 @@ import { Result } from "../types/fp.js"; * @remarks * Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function indexingDocumentsDebugMany( client: GleanCore, diff --git a/src/funcs/indexingDocumentsIndex.ts b/src/funcs/indexingDocumentsIndex.ts index 2b56d2e8..a7a88137 100644 --- a/src/funcs/indexingDocumentsIndex.ts +++ b/src/funcs/indexingDocumentsIndex.ts @@ -28,7 +28,7 @@ import { Result } from "../types/fp.js"; * Index documents * * @remarks - * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. + * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. */ export function indexingDocumentsIndex( client: GleanCore, diff --git a/src/funcs/indexingDocumentsStatus.ts b/src/funcs/indexingDocumentsStatus.ts index 33a441f5..4c29b482 100644 --- a/src/funcs/indexingDocumentsStatus.ts +++ b/src/funcs/indexingDocumentsStatus.ts @@ -29,7 +29,7 @@ import { Result } from "../types/fp.js"; * @remarks * Intended for debugging/validation. Fetches the current upload and indexing status of documents. * - * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-document) for richer information. + * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ diff --git a/src/funcs/indexingPeopleBulkIndex.ts b/src/funcs/indexingPeopleBulkIndex.ts index 803a4dfc..d9fe9b8b 100644 --- a/src/funcs/indexingPeopleBulkIndex.ts +++ b/src/funcs/indexingPeopleBulkIndex.ts @@ -28,7 +28,7 @@ import { Result } from "../types/fp.js"; * Bulk index employees * * @remarks - * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function indexingPeopleBulkIndex( client: GleanCore, diff --git a/src/funcs/indexingPeopleBulkIndexTeams.ts b/src/funcs/indexingPeopleBulkIndexTeams.ts index 2f431db6..93191619 100644 --- a/src/funcs/indexingPeopleBulkIndexTeams.ts +++ b/src/funcs/indexingPeopleBulkIndexTeams.ts @@ -28,7 +28,7 @@ import { Result } from "../types/fp.js"; * Bulk index teams * * @remarks - * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function indexingPeopleBulkIndexTeams( client: GleanCore, diff --git a/src/funcs/indexingPeopleCount.ts b/src/funcs/indexingPeopleCount.ts index ed336ea8..82f093bd 100644 --- a/src/funcs/indexingPeopleCount.ts +++ b/src/funcs/indexingPeopleCount.ts @@ -29,7 +29,7 @@ import { Result } from "../types/fp.js"; * @remarks * Fetches user count for the specified custom datasource. * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ diff --git a/src/funcs/indexingPeopleDebug.ts b/src/funcs/indexingPeopleDebug.ts index dab1e83c..6bf20f21 100644 --- a/src/funcs/indexingPeopleDebug.ts +++ b/src/funcs/indexingPeopleDebug.ts @@ -30,7 +30,7 @@ import { Result } from "../types/fp.js"; * @remarks * Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function indexingPeopleDebug( client: GleanCore, diff --git a/src/funcs/indexingPermissionsBulkIndexGroups.ts b/src/funcs/indexingPermissionsBulkIndexGroups.ts index 20cd8bcc..39c09850 100644 --- a/src/funcs/indexingPermissionsBulkIndexGroups.ts +++ b/src/funcs/indexingPermissionsBulkIndexGroups.ts @@ -28,7 +28,7 @@ import { Result } from "../types/fp.js"; * Bulk index groups * * @remarks - * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function indexingPermissionsBulkIndexGroups( client: GleanCore, diff --git a/src/funcs/indexingPermissionsBulkIndexMemberships.ts b/src/funcs/indexingPermissionsBulkIndexMemberships.ts index 7067c3c8..8836b064 100644 --- a/src/funcs/indexingPermissionsBulkIndexMemberships.ts +++ b/src/funcs/indexingPermissionsBulkIndexMemberships.ts @@ -28,7 +28,7 @@ import { Result } from "../types/fp.js"; * Bulk index memberships for a group * * @remarks - * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function indexingPermissionsBulkIndexMemberships( client: GleanCore, diff --git a/src/funcs/indexingPermissionsBulkIndexUsers.ts b/src/funcs/indexingPermissionsBulkIndexUsers.ts index 9b6c28ff..179da10d 100644 --- a/src/funcs/indexingPermissionsBulkIndexUsers.ts +++ b/src/funcs/indexingPermissionsBulkIndexUsers.ts @@ -28,7 +28,7 @@ import { Result } from "../types/fp.js"; * Bulk index users * * @remarks - * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function indexingPermissionsBulkIndexUsers( client: GleanCore, diff --git a/src/lib/config.ts b/src/lib/config.ts index eafb3d1c..d2cc9b0a 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.9.0", - sdkVersion: "0.8.1", + sdkVersion: "0.9.1", genVersion: "2.610.0", userAgent: - "speakeasy-sdk/typescript 0.8.1 2.610.0 0.9.0 @gleanwork/api-client", + "speakeasy-sdk/typescript 0.9.1 2.610.0 0.9.0 @gleanwork/api-client", } as const; diff --git a/src/models/components/documentdefinition.ts b/src/models/components/documentdefinition.ts index d219183f..f524d272 100644 --- a/src/models/components/documentdefinition.ts +++ b/src/models/components/documentdefinition.ts @@ -132,7 +132,7 @@ export type DocumentDefinition = { */ comments?: Array | undefined; /** - * Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/docs/facets_and_operators_for_custom_datasources/). + * Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). */ customProperties?: Array | undefined; }; diff --git a/src/models/components/feedback.ts b/src/models/components/feedback.ts index 1c8c3c4b..2fdcb6b8 100644 --- a/src/models/components/feedback.ts +++ b/src/models/components/feedback.ts @@ -13,6 +13,12 @@ import { ManualFeedbackInfo$Outbound, ManualFeedbackInfo$outboundSchema, } from "./manualfeedbackinfo.js"; +import { + ManualFeedbackSideBySideInfo, + ManualFeedbackSideBySideInfo$inboundSchema, + ManualFeedbackSideBySideInfo$Outbound, + ManualFeedbackSideBySideInfo$outboundSchema, +} from "./manualfeedbacksidebysideinfo.js"; import { SeenFeedbackInfo, SeenFeedbackInfo$inboundSchema, @@ -82,6 +88,7 @@ export const Event = { FocusIn: "FOCUS_IN", LastToken: "LAST_TOKEN", ManualFeedback: "MANUAL_FEEDBACK", + ManualFeedbackSideBySide: "MANUAL_FEEDBACK_SIDE_BY_SIDE", MarkAsRead: "MARK_AS_READ", Message: "MESSAGE", MiddleClick: "MIDDLE_CLICK", @@ -162,6 +169,7 @@ export type Feedback = { */ uiElement?: string | undefined; manualFeedbackInfo?: ManualFeedbackInfo | undefined; + manualFeedbackSideBySideInfo?: ManualFeedbackSideBySideInfo | undefined; seenFeedbackInfo?: SeenFeedbackInfo | undefined; userViewInfo?: UserViewInfo | undefined; workflowFeedbackInfo?: WorkflowFeedbackInfo | undefined; @@ -259,6 +267,8 @@ export const Feedback$inboundSchema: z.ZodType< uiTree: z.array(z.string()).optional(), uiElement: z.string().optional(), manualFeedbackInfo: ManualFeedbackInfo$inboundSchema.optional(), + manualFeedbackSideBySideInfo: ManualFeedbackSideBySideInfo$inboundSchema + .optional(), seenFeedbackInfo: SeenFeedbackInfo$inboundSchema.optional(), userViewInfo: UserViewInfo$inboundSchema.optional(), workflowFeedbackInfo: WorkflowFeedbackInfo$inboundSchema.optional(), @@ -283,6 +293,9 @@ export type Feedback$Outbound = { uiTree?: Array | undefined; uiElement?: string | undefined; manualFeedbackInfo?: ManualFeedbackInfo$Outbound | undefined; + manualFeedbackSideBySideInfo?: + | ManualFeedbackSideBySideInfo$Outbound + | undefined; seenFeedbackInfo?: SeenFeedbackInfo$Outbound | undefined; userViewInfo?: UserViewInfo$Outbound | undefined; workflowFeedbackInfo?: WorkflowFeedbackInfo$Outbound | undefined; @@ -311,6 +324,8 @@ export const Feedback$outboundSchema: z.ZodType< uiTree: z.array(z.string()).optional(), uiElement: z.string().optional(), manualFeedbackInfo: ManualFeedbackInfo$outboundSchema.optional(), + manualFeedbackSideBySideInfo: ManualFeedbackSideBySideInfo$outboundSchema + .optional(), seenFeedbackInfo: SeenFeedbackInfo$outboundSchema.optional(), userViewInfo: UserViewInfo$outboundSchema.optional(), workflowFeedbackInfo: WorkflowFeedbackInfo$outboundSchema.optional(), diff --git a/src/models/components/index.ts b/src/models/components/index.ts index fdc81a3f..1a99a8d8 100644 --- a/src/models/components/index.ts +++ b/src/models/components/index.ts @@ -267,6 +267,7 @@ export * from "./listpinsresponse.js"; export * from "./listshortcutspaginatedrequest.js"; export * from "./listshortcutspaginatedresponse.js"; export * from "./manualfeedbackinfo.js"; +export * from "./manualfeedbacksidebysideinfo.js"; export * from "./meeting.js"; export * from "./message.js"; export * from "./messagesrequest.js"; @@ -345,6 +346,7 @@ export * from "./shortcutinsight.js"; export * from "./shortcutinsightsresponse.js"; export * from "./shortcutmutableproperties.js"; export * from "./shortcutspaginationmetadata.js"; +export * from "./sidebysideimplementation.js"; export * from "./socialnetwork.js"; export * from "./socialnetworkdefinition.js"; export * from "./sortoptions.js"; diff --git a/src/models/components/manualfeedbackinfo.ts b/src/models/components/manualfeedbackinfo.ts index 85eb1310..6f313a78 100644 --- a/src/models/components/manualfeedbackinfo.ts +++ b/src/models/components/manualfeedbackinfo.ts @@ -63,14 +63,14 @@ export type Issue = ClosedEnum; /** * The vote associated with the Feedback.event.MANUAL_FEEDBACK event. */ -export const Vote = { +export const ManualFeedbackInfoVote = { Upvote: "UPVOTE", Downvote: "DOWNVOTE", } as const; /** * The vote associated with the Feedback.event.MANUAL_FEEDBACK event. */ -export type Vote = ClosedEnum; +export type ManualFeedbackInfoVote = ClosedEnum; export type ManualFeedbackInfo = { /** @@ -130,7 +130,7 @@ export type ManualFeedbackInfo = { /** * The vote associated with the Feedback.event.MANUAL_FEEDBACK event. */ - vote?: Vote | undefined; + vote?: ManualFeedbackInfoVote | undefined; /** * A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive. */ @@ -187,23 +187,24 @@ export namespace Issue$ { } /** @internal */ -export const Vote$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Vote, -); +export const ManualFeedbackInfoVote$inboundSchema: z.ZodNativeEnum< + typeof ManualFeedbackInfoVote +> = z.nativeEnum(ManualFeedbackInfoVote); /** @internal */ -export const Vote$outboundSchema: z.ZodNativeEnum = - Vote$inboundSchema; +export const ManualFeedbackInfoVote$outboundSchema: z.ZodNativeEnum< + typeof ManualFeedbackInfoVote +> = ManualFeedbackInfoVote$inboundSchema; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace Vote$ { - /** @deprecated use `Vote$inboundSchema` instead. */ - export const inboundSchema = Vote$inboundSchema; - /** @deprecated use `Vote$outboundSchema` instead. */ - export const outboundSchema = Vote$outboundSchema; +export namespace ManualFeedbackInfoVote$ { + /** @deprecated use `ManualFeedbackInfoVote$inboundSchema` instead. */ + export const inboundSchema = ManualFeedbackInfoVote$inboundSchema; + /** @deprecated use `ManualFeedbackInfoVote$outboundSchema` instead. */ + export const outboundSchema = ManualFeedbackInfoVote$outboundSchema; } /** @internal */ @@ -225,7 +226,7 @@ export const ManualFeedbackInfo$inboundSchema: z.ZodType< previousMessages: z.array(z.string()).optional(), chatTranscript: z.array(FeedbackChatExchange$inboundSchema).optional(), numQueriesFromFirstRun: z.number().int().optional(), - vote: Vote$inboundSchema.optional(), + vote: ManualFeedbackInfoVote$inboundSchema.optional(), rating: z.number().int().optional(), ratingKey: z.string().optional(), ratingScale: z.number().int().optional(), @@ -271,7 +272,7 @@ export const ManualFeedbackInfo$outboundSchema: z.ZodType< previousMessages: z.array(z.string()).optional(), chatTranscript: z.array(FeedbackChatExchange$outboundSchema).optional(), numQueriesFromFirstRun: z.number().int().optional(), - vote: Vote$outboundSchema.optional(), + vote: ManualFeedbackInfoVote$outboundSchema.optional(), rating: z.number().int().optional(), ratingKey: z.string().optional(), ratingScale: z.number().int().optional(), diff --git a/src/models/components/manualfeedbacksidebysideinfo.ts b/src/models/components/manualfeedbacksidebysideinfo.ts new file mode 100644 index 00000000..c010a994 --- /dev/null +++ b/src/models/components/manualfeedbacksidebysideinfo.ts @@ -0,0 +1,200 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { ClosedEnum } from "../../types/enums.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import { + SideBySideImplementation, + SideBySideImplementation$inboundSchema, + SideBySideImplementation$Outbound, + SideBySideImplementation$outboundSchema, +} from "./sidebysideimplementation.js"; + +/** + * The source associated with the side-by-side feedback event. + */ +export const ManualFeedbackSideBySideInfoSource = { + LiveEval: "LIVE_EVAL", + Chat: "CHAT", + Search: "SEARCH", +} as const; +/** + * The source associated with the side-by-side feedback event. + */ +export type ManualFeedbackSideBySideInfoSource = ClosedEnum< + typeof ManualFeedbackSideBySideInfoSource +>; + +/** + * The vote for this specific implementation. + */ +export const ManualFeedbackSideBySideInfoVote = { + Upvote: "UPVOTE", + Downvote: "DOWNVOTE", + Neutral: "NEUTRAL", +} as const; +/** + * The vote for this specific implementation. + */ +export type ManualFeedbackSideBySideInfoVote = ClosedEnum< + typeof ManualFeedbackSideBySideInfoVote +>; + +export type ManualFeedbackSideBySideInfo = { + /** + * The email address of the user who submitted the side-by-side feedback. + */ + email?: string | undefined; + /** + * The source associated with the side-by-side feedback event. + */ + source?: ManualFeedbackSideBySideInfoSource | undefined; + /** + * The query or prompt that was evaluated across multiple implementations. + */ + query?: string | undefined; + /** + * Array of implementations that were compared side-by-side. + */ + implementations?: Array | undefined; + /** + * Unique identifier for this evaluation session to group related feedback events. + */ + evaluationSessionId?: string | undefined; + /** + * The ID of the implementation this specific feedback event is for. + */ + implementationId?: string | undefined; + /** + * The vote for this specific implementation. + */ + vote?: ManualFeedbackSideBySideInfoVote | undefined; + /** + * Specific feedback comments for this implementation. + */ + comments?: string | undefined; +}; + +/** @internal */ +export const ManualFeedbackSideBySideInfoSource$inboundSchema: z.ZodNativeEnum< + typeof ManualFeedbackSideBySideInfoSource +> = z.nativeEnum(ManualFeedbackSideBySideInfoSource); + +/** @internal */ +export const ManualFeedbackSideBySideInfoSource$outboundSchema: z.ZodNativeEnum< + typeof ManualFeedbackSideBySideInfoSource +> = ManualFeedbackSideBySideInfoSource$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ManualFeedbackSideBySideInfoSource$ { + /** @deprecated use `ManualFeedbackSideBySideInfoSource$inboundSchema` instead. */ + export const inboundSchema = ManualFeedbackSideBySideInfoSource$inboundSchema; + /** @deprecated use `ManualFeedbackSideBySideInfoSource$outboundSchema` instead. */ + export const outboundSchema = + ManualFeedbackSideBySideInfoSource$outboundSchema; +} + +/** @internal */ +export const ManualFeedbackSideBySideInfoVote$inboundSchema: z.ZodNativeEnum< + typeof ManualFeedbackSideBySideInfoVote +> = z.nativeEnum(ManualFeedbackSideBySideInfoVote); + +/** @internal */ +export const ManualFeedbackSideBySideInfoVote$outboundSchema: z.ZodNativeEnum< + typeof ManualFeedbackSideBySideInfoVote +> = ManualFeedbackSideBySideInfoVote$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ManualFeedbackSideBySideInfoVote$ { + /** @deprecated use `ManualFeedbackSideBySideInfoVote$inboundSchema` instead. */ + export const inboundSchema = ManualFeedbackSideBySideInfoVote$inboundSchema; + /** @deprecated use `ManualFeedbackSideBySideInfoVote$outboundSchema` instead. */ + export const outboundSchema = ManualFeedbackSideBySideInfoVote$outboundSchema; +} + +/** @internal */ +export const ManualFeedbackSideBySideInfo$inboundSchema: z.ZodType< + ManualFeedbackSideBySideInfo, + z.ZodTypeDef, + unknown +> = z.object({ + email: z.string().optional(), + source: ManualFeedbackSideBySideInfoSource$inboundSchema.optional(), + query: z.string().optional(), + implementations: z.array(SideBySideImplementation$inboundSchema).optional(), + evaluationSessionId: z.string().optional(), + implementationId: z.string().optional(), + vote: ManualFeedbackSideBySideInfoVote$inboundSchema.optional(), + comments: z.string().optional(), +}); + +/** @internal */ +export type ManualFeedbackSideBySideInfo$Outbound = { + email?: string | undefined; + source?: string | undefined; + query?: string | undefined; + implementations?: Array | undefined; + evaluationSessionId?: string | undefined; + implementationId?: string | undefined; + vote?: string | undefined; + comments?: string | undefined; +}; + +/** @internal */ +export const ManualFeedbackSideBySideInfo$outboundSchema: z.ZodType< + ManualFeedbackSideBySideInfo$Outbound, + z.ZodTypeDef, + ManualFeedbackSideBySideInfo +> = z.object({ + email: z.string().optional(), + source: ManualFeedbackSideBySideInfoSource$outboundSchema.optional(), + query: z.string().optional(), + implementations: z.array(SideBySideImplementation$outboundSchema).optional(), + evaluationSessionId: z.string().optional(), + implementationId: z.string().optional(), + vote: ManualFeedbackSideBySideInfoVote$outboundSchema.optional(), + comments: z.string().optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ManualFeedbackSideBySideInfo$ { + /** @deprecated use `ManualFeedbackSideBySideInfo$inboundSchema` instead. */ + export const inboundSchema = ManualFeedbackSideBySideInfo$inboundSchema; + /** @deprecated use `ManualFeedbackSideBySideInfo$outboundSchema` instead. */ + export const outboundSchema = ManualFeedbackSideBySideInfo$outboundSchema; + /** @deprecated use `ManualFeedbackSideBySideInfo$Outbound` instead. */ + export type Outbound = ManualFeedbackSideBySideInfo$Outbound; +} + +export function manualFeedbackSideBySideInfoToJSON( + manualFeedbackSideBySideInfo: ManualFeedbackSideBySideInfo, +): string { + return JSON.stringify( + ManualFeedbackSideBySideInfo$outboundSchema.parse( + manualFeedbackSideBySideInfo, + ), + ); +} + +export function manualFeedbackSideBySideInfoFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => ManualFeedbackSideBySideInfo$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'ManualFeedbackSideBySideInfo' from JSON`, + ); +} diff --git a/src/models/components/searchresponsemetadata.ts b/src/models/components/searchresponsemetadata.ts index cb15f1d3..600d52f7 100644 --- a/src/models/components/searchresponsemetadata.ts +++ b/src/models/components/searchresponsemetadata.ts @@ -40,6 +40,10 @@ export type SearchResponseMetadata = { * The actual query used to perform search and return results. */ searchedQuery?: string | undefined; + /** + * The query used to perform search and return results, with negated terms and facets removed. + */ + searchedQueryWithoutNegation?: string | undefined; /** * The bolded ranges within the searched query. */ @@ -81,6 +85,7 @@ export const SearchResponseMetadata$inboundSchema: z.ZodType< > = z.object({ rewrittenQuery: z.string().optional(), searchedQuery: z.string().optional(), + searchedQueryWithoutNegation: z.string().optional(), searchedQueryRanges: z.array(TextRange$inboundSchema).optional(), originalQuery: z.string().optional(), querySuggestion: QuerySuggestion$inboundSchema.optional(), @@ -97,6 +102,7 @@ export const SearchResponseMetadata$inboundSchema: z.ZodType< export type SearchResponseMetadata$Outbound = { rewrittenQuery?: string | undefined; searchedQuery?: string | undefined; + searchedQueryWithoutNegation?: string | undefined; searchedQueryRanges?: Array | undefined; originalQuery?: string | undefined; querySuggestion?: QuerySuggestion$Outbound | undefined; @@ -117,6 +123,7 @@ export const SearchResponseMetadata$outboundSchema: z.ZodType< > = z.object({ rewrittenQuery: z.string().optional(), searchedQuery: z.string().optional(), + searchedQueryWithoutNegation: z.string().optional(), searchedQueryRanges: z.array(TextRange$outboundSchema).optional(), originalQuery: z.string().optional(), querySuggestion: QuerySuggestion$outboundSchema.optional(), diff --git a/src/models/components/sidebysideimplementation.ts b/src/models/components/sidebysideimplementation.ts new file mode 100644 index 00000000..5b175a9d --- /dev/null +++ b/src/models/components/sidebysideimplementation.ts @@ -0,0 +1,175 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +/** + * Metadata about the response (e.g., latency, token count). + */ +export type ResponseMetadata = { + /** + * Time taken to generate the response in milliseconds. + */ + latencyMs?: number | undefined; + /** + * Number of tokens in the response. + */ + tokenCount?: number | undefined; + /** + * The specific model version used. + */ + modelUsed?: string | undefined; +}; + +export type SideBySideImplementation = { + /** + * Unique identifier for this implementation variant. + */ + implementationId?: string | undefined; + /** + * Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude"). + */ + implementationName?: string | undefined; + /** + * The search/chat parameters used for this implementation. + */ + searchParams?: { [k: string]: string } | undefined; + /** + * The full response generated by this implementation. + */ + response?: string | undefined; + /** + * Metadata about the response (e.g., latency, token count). + */ + responseMetadata?: ResponseMetadata | undefined; +}; + +/** @internal */ +export const ResponseMetadata$inboundSchema: z.ZodType< + ResponseMetadata, + z.ZodTypeDef, + unknown +> = z.object({ + latencyMs: z.number().int().optional(), + tokenCount: z.number().int().optional(), + modelUsed: z.string().optional(), +}); + +/** @internal */ +export type ResponseMetadata$Outbound = { + latencyMs?: number | undefined; + tokenCount?: number | undefined; + modelUsed?: string | undefined; +}; + +/** @internal */ +export const ResponseMetadata$outboundSchema: z.ZodType< + ResponseMetadata$Outbound, + z.ZodTypeDef, + ResponseMetadata +> = z.object({ + latencyMs: z.number().int().optional(), + tokenCount: z.number().int().optional(), + modelUsed: z.string().optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ResponseMetadata$ { + /** @deprecated use `ResponseMetadata$inboundSchema` instead. */ + export const inboundSchema = ResponseMetadata$inboundSchema; + /** @deprecated use `ResponseMetadata$outboundSchema` instead. */ + export const outboundSchema = ResponseMetadata$outboundSchema; + /** @deprecated use `ResponseMetadata$Outbound` instead. */ + export type Outbound = ResponseMetadata$Outbound; +} + +export function responseMetadataToJSON( + responseMetadata: ResponseMetadata, +): string { + return JSON.stringify( + ResponseMetadata$outboundSchema.parse(responseMetadata), + ); +} + +export function responseMetadataFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => ResponseMetadata$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'ResponseMetadata' from JSON`, + ); +} + +/** @internal */ +export const SideBySideImplementation$inboundSchema: z.ZodType< + SideBySideImplementation, + z.ZodTypeDef, + unknown +> = z.object({ + implementationId: z.string().optional(), + implementationName: z.string().optional(), + searchParams: z.record(z.string()).optional(), + response: z.string().optional(), + responseMetadata: z.lazy(() => ResponseMetadata$inboundSchema).optional(), +}); + +/** @internal */ +export type SideBySideImplementation$Outbound = { + implementationId?: string | undefined; + implementationName?: string | undefined; + searchParams?: { [k: string]: string } | undefined; + response?: string | undefined; + responseMetadata?: ResponseMetadata$Outbound | undefined; +}; + +/** @internal */ +export const SideBySideImplementation$outboundSchema: z.ZodType< + SideBySideImplementation$Outbound, + z.ZodTypeDef, + SideBySideImplementation +> = z.object({ + implementationId: z.string().optional(), + implementationName: z.string().optional(), + searchParams: z.record(z.string()).optional(), + response: z.string().optional(), + responseMetadata: z.lazy(() => ResponseMetadata$outboundSchema).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace SideBySideImplementation$ { + /** @deprecated use `SideBySideImplementation$inboundSchema` instead. */ + export const inboundSchema = SideBySideImplementation$inboundSchema; + /** @deprecated use `SideBySideImplementation$outboundSchema` instead. */ + export const outboundSchema = SideBySideImplementation$outboundSchema; + /** @deprecated use `SideBySideImplementation$Outbound` instead. */ + export type Outbound = SideBySideImplementation$Outbound; +} + +export function sideBySideImplementationToJSON( + sideBySideImplementation: SideBySideImplementation, +): string { + return JSON.stringify( + SideBySideImplementation$outboundSchema.parse(sideBySideImplementation), + ); +} + +export function sideBySideImplementationFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => SideBySideImplementation$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'SideBySideImplementation' from JSON`, + ); +} diff --git a/src/react-query/indexingAuthenticationRotateToken.ts b/src/react-query/indexingAuthenticationRotateToken.ts index 01a0c0ec..b9ca62ee 100644 --- a/src/react-query/indexingAuthenticationRotateToken.ts +++ b/src/react-query/indexingAuthenticationRotateToken.ts @@ -27,7 +27,7 @@ export type IndexingAuthenticationRotateTokenMutationData = * Rotate token * * @remarks - * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/docs/indexing_api_token_rotation/) documentation for more information. + * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. */ export function useIndexingAuthenticationRotateTokenMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingDatasourceStatus.ts b/src/react-query/indexingDatasourceStatus.ts index d9e1eca6..3873f31c 100644 --- a/src/react-query/indexingDatasourceStatus.ts +++ b/src/react-query/indexingDatasourceStatus.ts @@ -30,7 +30,7 @@ export type IndexingDatasourceStatusMutationData = * @remarks * Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function useIndexingDatasourceStatusMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingDocumentsBulkIndex.ts b/src/react-query/indexingDocumentsBulkIndex.ts index efdccd13..f8656fb9 100644 --- a/src/react-query/indexingDocumentsBulkIndex.ts +++ b/src/react-query/indexingDocumentsBulkIndex.ts @@ -27,7 +27,7 @@ export type IndexingDocumentsBulkIndexMutationData = void; * Bulk index documents * * @remarks - * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function useIndexingDocumentsBulkIndexMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingDocumentsCheckAccess.ts b/src/react-query/indexingDocumentsCheckAccess.ts index a23a93fe..a8d6faac 100644 --- a/src/react-query/indexingDocumentsCheckAccess.ts +++ b/src/react-query/indexingDocumentsCheckAccess.ts @@ -30,7 +30,7 @@ export type IndexingDocumentsCheckAccessMutationData = * @remarks * Check if a given user has access to access a document in a custom datasource * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function useIndexingDocumentsCheckAccessMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingDocumentsCount.ts b/src/react-query/indexingDocumentsCount.ts index dfa8284b..b11156cc 100644 --- a/src/react-query/indexingDocumentsCount.ts +++ b/src/react-query/indexingDocumentsCount.ts @@ -30,7 +30,7 @@ export type IndexingDocumentsCountMutationData = * @remarks * Fetches document count for the specified custom datasource. * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ diff --git a/src/react-query/indexingDocumentsDebug.ts b/src/react-query/indexingDocumentsDebug.ts index 56888ee0..156165a6 100644 --- a/src/react-query/indexingDocumentsDebug.ts +++ b/src/react-query/indexingDocumentsDebug.ts @@ -31,7 +31,7 @@ export type IndexingDocumentsDebugMutationData = * @remarks * Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function useIndexingDocumentsDebugMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingDocumentsDebugMany.ts b/src/react-query/indexingDocumentsDebugMany.ts index dd631339..db2feab6 100644 --- a/src/react-query/indexingDocumentsDebugMany.ts +++ b/src/react-query/indexingDocumentsDebugMany.ts @@ -31,7 +31,7 @@ export type IndexingDocumentsDebugManyMutationData = * @remarks * Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function useIndexingDocumentsDebugManyMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingDocumentsIndex.ts b/src/react-query/indexingDocumentsIndex.ts index bd8da495..9eca591e 100644 --- a/src/react-query/indexingDocumentsIndex.ts +++ b/src/react-query/indexingDocumentsIndex.ts @@ -27,7 +27,7 @@ export type IndexingDocumentsIndexMutationData = void; * Index documents * * @remarks - * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. + * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. */ export function useIndexingDocumentsIndexMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingDocumentsStatus.ts b/src/react-query/indexingDocumentsStatus.ts index c9e0ae35..2753b4ce 100644 --- a/src/react-query/indexingDocumentsStatus.ts +++ b/src/react-query/indexingDocumentsStatus.ts @@ -30,7 +30,7 @@ export type IndexingDocumentsStatusMutationData = * @remarks * Intended for debugging/validation. Fetches the current upload and indexing status of documents. * - * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-document) for richer information. + * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ diff --git a/src/react-query/indexingPeopleBulkIndex.ts b/src/react-query/indexingPeopleBulkIndex.ts index 36cea6cd..98cefeac 100644 --- a/src/react-query/indexingPeopleBulkIndex.ts +++ b/src/react-query/indexingPeopleBulkIndex.ts @@ -27,7 +27,7 @@ export type IndexingPeopleBulkIndexMutationData = void; * Bulk index employees * * @remarks - * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function useIndexingPeopleBulkIndexMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingPeopleBulkIndexTeams.ts b/src/react-query/indexingPeopleBulkIndexTeams.ts index daf2ad85..afb9106a 100644 --- a/src/react-query/indexingPeopleBulkIndexTeams.ts +++ b/src/react-query/indexingPeopleBulkIndexTeams.ts @@ -27,7 +27,7 @@ export type IndexingPeopleBulkIndexTeamsMutationData = void; * Bulk index teams * * @remarks - * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function useIndexingPeopleBulkIndexTeamsMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingPeopleCount.ts b/src/react-query/indexingPeopleCount.ts index a0b49530..5319ad33 100644 --- a/src/react-query/indexingPeopleCount.ts +++ b/src/react-query/indexingPeopleCount.ts @@ -29,7 +29,7 @@ export type IndexingPeopleCountMutationData = components.GetUserCountResponse; * @remarks * Fetches user count for the specified custom datasource. * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ diff --git a/src/react-query/indexingPeopleDebug.ts b/src/react-query/indexingPeopleDebug.ts index 854eac28..e265a49f 100644 --- a/src/react-query/indexingPeopleDebug.ts +++ b/src/react-query/indexingPeopleDebug.ts @@ -30,7 +30,7 @@ export type IndexingPeopleDebugMutationData = components.DebugUserResponse; * @remarks * Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ export function useIndexingPeopleDebugMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingPermissionsBulkIndexGroups.ts b/src/react-query/indexingPermissionsBulkIndexGroups.ts index ff1b0886..c3148724 100644 --- a/src/react-query/indexingPermissionsBulkIndexGroups.ts +++ b/src/react-query/indexingPermissionsBulkIndexGroups.ts @@ -27,7 +27,7 @@ export type IndexingPermissionsBulkIndexGroupsMutationData = void; * Bulk index groups * * @remarks - * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function useIndexingPermissionsBulkIndexGroupsMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingPermissionsBulkIndexMemberships.ts b/src/react-query/indexingPermissionsBulkIndexMemberships.ts index c2bdafb2..661841a2 100644 --- a/src/react-query/indexingPermissionsBulkIndexMemberships.ts +++ b/src/react-query/indexingPermissionsBulkIndexMemberships.ts @@ -27,7 +27,7 @@ export type IndexingPermissionsBulkIndexMembershipsMutationData = void; * Bulk index memberships for a group * * @remarks - * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function useIndexingPermissionsBulkIndexMembershipsMutation( options?: MutationHookOptions< diff --git a/src/react-query/indexingPermissionsBulkIndexUsers.ts b/src/react-query/indexingPermissionsBulkIndexUsers.ts index fa38bc6f..da72ad8b 100644 --- a/src/react-query/indexingPermissionsBulkIndexUsers.ts +++ b/src/react-query/indexingPermissionsBulkIndexUsers.ts @@ -27,7 +27,7 @@ export type IndexingPermissionsBulkIndexUsersMutationData = void; * Bulk index users * * @remarks - * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ export function useIndexingPermissionsBulkIndexUsersMutation( options?: MutationHookOptions< diff --git a/src/sdk/datasource.ts b/src/sdk/datasource.ts index 6392b615..7a6c21db 100644 --- a/src/sdk/datasource.ts +++ b/src/sdk/datasource.ts @@ -14,7 +14,7 @@ export class Datasource extends ClientSDK { * @remarks * Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ async status( datasource: string, diff --git a/src/sdk/indexingauthentication.ts b/src/sdk/indexingauthentication.ts index 2ce923cd..6a362930 100644 --- a/src/sdk/indexingauthentication.ts +++ b/src/sdk/indexingauthentication.ts @@ -12,7 +12,7 @@ export class IndexingAuthentication extends ClientSDK { * Rotate token * * @remarks - * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/docs/indexing_api_token_rotation/) documentation for more information. + * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. */ async rotateToken( options?: RequestOptions, diff --git a/src/sdk/indexingdocuments.ts b/src/sdk/indexingdocuments.ts index 765797e2..e529bd51 100644 --- a/src/sdk/indexingdocuments.ts +++ b/src/sdk/indexingdocuments.ts @@ -38,7 +38,7 @@ export class IndexingDocuments extends ClientSDK { * Index documents * * @remarks - * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. + * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. */ async index( request: components.IndexDocumentsRequest, @@ -55,7 +55,7 @@ export class IndexingDocuments extends ClientSDK { * Bulk index documents * * @remarks - * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ async bulkIndex( request: components.BulkIndexDocumentsRequest, @@ -118,7 +118,7 @@ export class IndexingDocuments extends ClientSDK { * @remarks * Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ async debug( debugDocumentRequest: components.DebugDocumentRequest, @@ -139,7 +139,7 @@ export class IndexingDocuments extends ClientSDK { * @remarks * Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ async debugMany( debugDocumentsRequest: components.DebugDocumentsRequest, @@ -160,7 +160,7 @@ export class IndexingDocuments extends ClientSDK { * @remarks * Check if a given user has access to access a document in a custom datasource * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ async checkAccess( request: components.CheckDocumentAccessRequest, @@ -179,7 +179,7 @@ export class IndexingDocuments extends ClientSDK { * @remarks * Intended for debugging/validation. Fetches the current upload and indexing status of documents. * - * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-document) for richer information. + * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ @@ -200,7 +200,7 @@ export class IndexingDocuments extends ClientSDK { * @remarks * Fetches document count for the specified custom datasource. * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ diff --git a/src/sdk/people.ts b/src/sdk/people.ts index d923222a..986fed6e 100644 --- a/src/sdk/people.ts +++ b/src/sdk/people.ts @@ -22,7 +22,7 @@ export class People extends ClientSDK { * @remarks * Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information. + * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. */ async debug( debugUserRequest: components.DebugUserRequest, @@ -43,7 +43,7 @@ export class People extends ClientSDK { * @remarks * Fetches user count for the specified custom datasource. * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information. + * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ @@ -79,7 +79,7 @@ export class People extends ClientSDK { * Bulk index employees * * @remarks - * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ async bulkIndex( request: components.BulkIndexEmployeesRequest, @@ -162,7 +162,7 @@ export class People extends ClientSDK { * Bulk index teams * * @remarks - * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ async bulkIndexTeams( request: components.BulkIndexTeamsRequest, diff --git a/src/sdk/permissions.ts b/src/sdk/permissions.ts index 90d4bc7b..c1c64c01 100644 --- a/src/sdk/permissions.ts +++ b/src/sdk/permissions.ts @@ -57,7 +57,7 @@ export class Permissions extends ClientSDK { * Bulk index users * * @remarks - * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ async bulkIndexUsers( request: components.BulkIndexUsersRequest, @@ -91,7 +91,7 @@ export class Permissions extends ClientSDK { * Bulk index groups * * @remarks - * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ async bulkIndexGroups( request: components.BulkIndexGroupsRequest, @@ -125,7 +125,7 @@ export class Permissions extends ClientSDK { * Bulk index memberships for a group * * @remarks - * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints. + * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. */ async bulkIndexMemberships( request: components.BulkIndexMembershipsRequest,