Skip to content

Feat/add knowledge download #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jose-Sabater merged 2 commits into from
Dec 1, 2025
Merged

Feat/add knowledge download #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4cf74a
add file download endpoint
Jose-Sabater Nov 28, 2025
cac15fb
regenerate
Jose-Sabater Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 32 additions & 9 deletions .speakeasy/gen.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
lockVersion: 2.0.0
id: 7fd487cb-2a73-459e-99e5-2c4e6547175f
management:
docChecksum: 8a701aa5036da0a2919658f49f4c88f3
docChecksum: a460a1ebe6ede9e586a70b25d2a661ba
docVersion: 2.0.0
speakeasyVersion: 1.660.0
generationVersion: 2.760.2
releaseVersion: 3.3.1
configChecksum: 18bd011b72904dd62ac5fb36d42f1066
speakeasyVersion: 1.664.0
generationVersion: 2.766.1
releaseVersion: 3.3.2
configChecksum: 8c82f1e2d056460a762ab90c9324d283
features:
typescript:
additionalDependencies: 0.1.0
additionalProperties: 0.1.2
constsAndDefaults: 0.1.12
core: 3.26.9
core: 3.26.12
defaultEnabledRetries: 0.1.0
devContainers: 2.90.1
enumUnions: 0.1.0
Expand All @@ -30,7 +30,7 @@ features:
retries: 2.83.0
sdkHooks: 0.3.0
serverEvents: 0.1.12
unions: 2.86.0
unions: 2.86.2
generatedFiles:
- .devcontainer/README.md
- .devcontainer/devcontainer.json
Expand Down Expand Up @@ -148,6 +148,7 @@ generatedFiles:
- docs/models/errors/unauthorizederror.md
- docs/models/example.md
- docs/models/examplein.md
- docs/models/filedownloadurlresponse.md
- docs/models/filefile.md
- docs/models/filet.md
- docs/models/filter.md
Expand Down Expand Up @@ -217,6 +218,7 @@ generatedFiles:
- docs/models/operations/getcustommodelbynamemodelscustombynamenamegetrequest.md
- docs/models/operations/getcustommodelmodelscustommodelidgetrequest.md
- docs/models/operations/getdatasetentrydatasetsdatasetidentriesentryidgetrequest.md
- docs/models/operations/getfiledownloadurlknowledgeknowledgebaseidfilesfileiddownloadurlgetrequest.md
- docs/models/operations/getfunctionbynamefunctionsbynamenamegetrequest.md
- docs/models/operations/getfunctionbyrevisionfunctionsfunctionidrevisionsrevisionidgetrequest.md
- docs/models/operations/getfunctionfunctionsfunctionidgetrequest.md
Expand Down Expand Up @@ -367,6 +369,7 @@ generatedFiles:
- src/funcs/knowledgeDeleteFile.ts
- src/funcs/knowledgeGet.ts
- src/funcs/knowledgeGetByName.ts
- src/funcs/knowledgeGetFileDownloadUrl.ts
- src/funcs/knowledgeGetUploadUrl.ts
- src/funcs/knowledgeList.ts
- src/funcs/knowledgeListFiles.ts
Expand Down Expand Up @@ -463,6 +466,7 @@ generatedFiles:
- src/mcp-server/tools/knowledgeDeleteFile.ts
- src/mcp-server/tools/knowledgeGet.ts
- src/mcp-server/tools/knowledgeGetByName.ts
- src/mcp-server/tools/knowledgeGetFileDownloadUrl.ts
- src/mcp-server/tools/knowledgeGetUploadUrl.ts
- src/mcp-server/tools/knowledgeList.ts
- src/mcp-server/tools/knowledgeListFiles.ts
Expand Down Expand Up @@ -574,6 +578,7 @@ generatedFiles:
- src/models/example.ts
- src/models/examplein.ts
- src/models/file.ts
- src/models/filedownloadurlresponse.ts
- src/models/filefile.ts
- src/models/filter.ts
- src/models/functioncallconfigurationinput.ts
Expand Down Expand Up @@ -636,6 +641,7 @@ generatedFiles:
- src/models/operations/getcustommodelbynamemodelscustombynamenameget.ts
- src/models/operations/getcustommodelmodelscustommodelidget.ts
- src/models/operations/getdatasetentrydatasetsdatasetidentriesentryidget.ts
- src/models/operations/getfiledownloadurlknowledgeknowledgebaseidfilesfileiddownloadurlget.ts
- src/models/operations/getfunctionbynamefunctionsbynamenameget.ts
- src/models/operations/getfunctionbyrevisionfunctionsfunctionidrevisionsrevisionidget.ts
- src/models/operations/getfunctionfunctionsfunctionidget.ts
Expand Down Expand Up @@ -1026,7 +1032,7 @@ examples:
path:
span_id: "77b258a2-45c1-4b87-a50c-9116bc8ed1d6"
requestBody:
application/json: {"name": "my span", "start_time": "2025-11-21T16:13:26.520750Z", "type": "email_tool", "end_time": "2025-11-21T16:13:26.520845Z", "input": "Hello, world!", "output": "Hello, world!", "error": "Exception: This is an error message", "meta": {"key": "value"}, "score": 10}
application/json: {"name": "my span", "start_time": "2025-11-28T13:52:33.685136Z", "type": "email_tool", "end_time": "2025-11-28T13:52:33.685231Z", "input": "Hello, world!", "output": "Hello, world!", "error": "Exception: This is an error message", "meta": {"key": "value"}, "score": 10}
responses:
"200":
application/json: {"name": "my span", "start_time": "2024-03-20T10:00:00+00:00", "id": "84d9ffc8-336c-4953-b92f-fe05d5405951", "trace_id": "123e4567-e89b-12d3-a456-426614174000", "parent_id": "123e4567-e89b-12d3-a456-426614174000", "type": "email_tool", "end_time": "2024-03-20T10:00:10+00:00", "input": "Hello, world!", "output": "Hello, world!", "error": "Exception: This is an error message", "meta": {"key": "value"}, "score": 10}
Expand Down Expand Up @@ -1749,7 +1755,7 @@ examples:
path:
knowledge_base_id: "3c6931ec-d324-46b6-bec6-bf31a5f0623f"
requestBody:
application/json: {"filename": "example.pdf", "file_id": "0dff5851-c155-4a46-8450-5b96eb017ae5", "content_type": "application/pdf"}
application/json: {"filename": "example.pdf", "file_id": "0dff5851-c155-4a46-8450-5b96eb017ae5", "content_type": "application/pdf", "metadata": {"category": "legal", "client": "acme"}}
responses:
"201":
application/json: {"id": "8c8543c2-ed47-4e71-a474-8c7f688fd79c", "key": "<key>", "original_filename": "<value>", "document_id": 667726}
Expand Down Expand Up @@ -1993,5 +1999,22 @@ examples:
application/json: {"type": "NotFoundError", "message": "The resource was not found", "detail": "Span 123e4567-e89b-12d3-a456-426614174000 not found"}
"422":
application/json: {"type": "RequestValidationError", "message": "The request is invalid", "detail": {"input": "input value", "loc": ["path", "to", "error"], "msg": "error message", "type": "type of error"}}
get_file_download_url_knowledge__knowledge_base_id__files__file_id__download_url_get:
speakeasy-default-get-file-download-url-knowledge-knowledge-base-id-files-file-id-download-url-get:
parameters:
path:
knowledge_base_id: "3d6f9cb0-cbf2-4c9a-8995-331034439b8d"
file_id: "d917ff5b-acf0-4e5c-943a-7d584204a9f3"
responses:
"200":
application/json: {"url": "https://best-availability.name/", "expires_in": 554035}
"400":
application/json: {"type": "BadRequestError", "message": "The request is invalid", "detail": "The request is invalid"}
"401":
application/json: {"type": "UnauthorizedError", "message": "The request is unauthorized", "detail": "The API key is invalid"}
"404":
application/json: {"type": "NotFoundError", "message": "The resource was not found", "detail": "Span 123e4567-e89b-12d3-a456-426614174000 not found"}
"422":
application/json: {"type": "RequestValidationError", "message": "The request is invalid", "detail": {"input": "input value", "loc": ["path", "to", "error"], "msg": "error message", "type": "type of error"}}
examplesVersion: 1.0.2
generatedTests: {}
6 changes: 5 additions & 1 deletion .speakeasy/gen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ generation:
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 3.3.1
version: 3.3.2
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
Expand All @@ -54,7 +54,9 @@ typescript:
exportZodModelNamespace: false
flattenGlobalSecurity: true
flatteningOrder: parameters-first
formStringArrayEncodeMode: encoded-string
forwardCompatibleEnumsByDefault: false
forwardCompatibleUnionsByDefault: "false"
generateExamples: true
imports:
option: openapi
Expand All @@ -64,13 +66,15 @@ typescript:
operations: models/operations
shared: models
webhooks: models/webhooks
inferUnionDiscriminators: true
inputModelSuffix: input
jsonpath: rfc9535
laxMode: strict
maxMethodParams: 99
methodArguments: require-security-and-request
modelPropertyCasing: camel
moduleFormat: dual
multipartArrayFormat: legacy
outputModelSuffix: output
packageName: opperai
responseFormat: flat
Expand Down
9 changes: 9 additions & 0 deletions .speakeasy/speakeasy-modifications-overlay.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,3 +736,12 @@ actions:
created_at: 1732439000000
reviewed_at: 1732439000000
type: method-name
- target: $["paths"]["/knowledge/{knowledge_base_id}/files/{file_id}/download_url"]["get"]
update:
x-speakeasy-name-override: getFileDownloadUrl
x-speakeasy-metadata:
after: sdk.knowledge.getFileDownloadUrl()
before: sdk.knowledge.get_file_download_url_knowledge__knowledge_base_id__files__file_id__download_url_get()
created_at: 1732872000000
reviewed_at: 1732872000000
type: method-name
12 changes: 6 additions & 6 deletions .speakeasy/workflow.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
speakeasyVersion: 1.660.0
speakeasyVersion: 1.664.0
sources:
FastAPI:
sourceNamespace: fast-api
sourceRevisionDigest: sha256:bd3231659ba8b906113e299659f433b250ed9df2bdc5b997514a683f29ec32d4
sourceBlobDigest: sha256:dd8abd2f9e02dd0aa2ceaae1792f85e2c2e0cdec533cb2b46976734b60aa2d5f
sourceRevisionDigest: sha256:96c05ebf50787da9b70ff351605b19d5d0ee37a6d96719e9bf18e0fea8163d7e
sourceBlobDigest: sha256:8ba1960e535cf0cc797a118bca7a9325a2dae0615250814ec9fa6f9c3faf3631
tags:
- latest
- 2.0.0
targets:
opper:
source: FastAPI
sourceNamespace: fast-api
sourceRevisionDigest: sha256:bd3231659ba8b906113e299659f433b250ed9df2bdc5b997514a683f29ec32d4
sourceBlobDigest: sha256:dd8abd2f9e02dd0aa2ceaae1792f85e2c2e0cdec533cb2b46976734b60aa2d5f
sourceRevisionDigest: sha256:96c05ebf50787da9b70ff351605b19d5d0ee37a6d96719e9bf18e0fea8163d7e
sourceBlobDigest: sha256:8ba1960e535cf0cc797a118bca7a9325a2dae0615250814ec9fa6f9c3faf3631
codeSamplesNamespace: fast-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:908f1a1d5358dad84a584d2b52429cfa753bcf7052704e51c0140f7bdec02dbe
codeSamplesRevisionDigest: sha256:bb5610491dbaf2387cbcb8c6cfcae50804b90cbaa81890e0c98573c64c44542b
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
19 changes: 19 additions & 0 deletions docs/models/filedownloadurlresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# FileDownloadUrlResponse

## Example Usage

```typescript
import { FileDownloadUrlResponse } from "opperai/models";

let value: FileDownloadUrlResponse = {
url: "https://overcooked-thyme.name",
expiresIn: 13071,
};
```

## Fields

| Field | Type | Required | Description |
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
| `url` | *string* | :heavy_check_mark: | Presigned URL to download the file |
| `expiresIn` | *number* | :heavy_check_mark: | Number of seconds until the URL expires |
19 changes: 12 additions & 7 deletions docs/models/listfilesresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,20 @@ let value: ListFilesResponse = {
size: 351349,
status: "<value>",
documentId: 118298,
metadata: {
"category": "legal",
"client": "acme",
},
};
```

## Fields

| Field | Type | Required | Description |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `id` | *string* | :heavy_check_mark: | The id of the file |
| `originalFilename` | *string* | :heavy_check_mark: | The original filename |
| `size` | *number* | :heavy_check_mark: | The size of the file in bytes |
| `status` | *string* | :heavy_check_mark: | The indexing status of the file |
| `documentId` | *number* | :heavy_check_mark: | The id of the associated document |
| Field | Type | Required | Description | Example |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `id` | *string* | :heavy_check_mark: | The id of the file | |
| `originalFilename` | *string* | :heavy_check_mark: | The original filename | |
| `size` | *number* | :heavy_check_mark: | The size of the file in bytes | |
| `status` | *string* | :heavy_check_mark: | The indexing status of the file | |
| `documentId` | *number* | :heavy_check_mark: | The id of the associated document | |
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | The metadata attached to the file | {<br/>"category": "legal",<br/>"client": "acme"<br/>} |
20 changes: 20 additions & 0 deletions ...s/getfiledownloadurlknowledgeknowledgebaseidfilesfileiddownloadurlgetrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# GetFileDownloadUrlKnowledgeKnowledgeBaseIdFilesFileIdDownloadUrlGetRequest

## Example Usage

```typescript
import { GetFileDownloadUrlKnowledgeKnowledgeBaseIdFilesFileIdDownloadUrlGetRequest } from "opperai/models/operations";

let value:
GetFileDownloadUrlKnowledgeKnowledgeBaseIdFilesFileIdDownloadUrlGetRequest = {
knowledgeBaseId: "a52ff0c1-a1ef-4bb7-939a-bd9357631e39",
fileId: "728e40e6-0612-4027-8f0c-cf4e079a288b",
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `knowledgeBaseId` | *string* | :heavy_check_mark: | The id of the knowledge base |
| `fileId` | *string* | :heavy_check_mark: | The id of the file |
4 changes: 4 additions & 0 deletions ...operations/registerfileuploadknowledgeknowledgebaseidregisterfilepostrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ let value: RegisterFileUploadKnowledgeKnowledgeBaseIdRegisterFilePostRequest = {
filename: "example.pdf",
fileId: "1ea8fd4c-c52c-4100-8653-01ab93359ed1",
contentType: "application/pdf",
metadata: {
"category": "legal",
"client": "acme",
},
},
};
```
Expand Down
4 changes: 2 additions & 2 deletions docs/models/operations/updatespanspansspanidpatchrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ let value: UpdateSpanSpansSpanIdPatchRequest = {
spanId: "c4686ca8-5f9f-483e-8cc2-e12731bcf9e5",
updateSpanRequest: {
name: "my span",
startTime: new Date("2025-11-21T16:13:26.520750Z"),
startTime: new Date("2025-11-28T13:52:33.685136Z"),
type: "email_tool",
endTime: new Date("2025-11-21T16:13:26.520845Z"),
endTime: new Date("2025-11-28T13:52:33.685231Z"),
input: "Hello, world!",
output: "Hello, world!",
error: "Exception: This is an error message",
Expand Down
4 changes: 4 additions & 0 deletions docs/models/paginatedresponselistfilesresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ let value: PaginatedResponseListFilesResponse = {
size: 283826,
status: "<value>",
documentId: 185150,
metadata: {
"category": "legal",
"client": "acme",
},
},
],
};
Expand Down
7 changes: 6 additions & 1 deletion docs/models/registerfileuploadrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ let value: RegisterFileUploadRequest = {
filename: "example.pdf",
fileId: "a6985676-1a18-4da3-8dc0-13029ff25547",
contentType: "application/pdf",
metadata: {
"category": "legal",
"client": "acme",
},
};
```

Expand All @@ -19,4 +23,5 @@ let value: RegisterFileUploadRequest = {
| `filename` | *string* | :heavy_check_mark: | The filename of the file to register | example.pdf |
| `fileId` | *string* | :heavy_check_mark: | The id of the file to register | |
| `contentType` | *string* | :heavy_check_mark: | The content type of the file to register | application/pdf |
| `configuration` | [models.TextProcessingConfiguration](../models/textprocessingconfiguration.md) | :heavy_minus_sign: | The configuration for the file to register | |
| `configuration` | [models.TextProcessingConfiguration](../models/textprocessingconfiguration.md) | :heavy_minus_sign: | The configuration for the file to register | |
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | Optional metadata to attach to the file | {<br/>"category": "legal",<br/>"client": "acme"<br/>} |
13 changes: 7 additions & 6 deletions docs/models/registerfileuploadresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ let value: RegisterFileUploadResponse = {

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *string* | :heavy_check_mark: | N/A |
| `key` | *string* | :heavy_check_mark: | N/A |
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
| `documentId` | *number* | :heavy_check_mark: | N/A |
| Field | Type | Required | Description |
| --------------------- | --------------------- | --------------------- | --------------------- |
| `id` | *string* | :heavy_check_mark: | N/A |
| `key` | *string* | :heavy_check_mark: | N/A |
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
| `documentId` | *number* | :heavy_check_mark: | N/A |
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
Loading