@usecortex_ai/node 0.3.5 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Client.d.ts +20 -24
- package/dist/Client.js +26 -34
- package/dist/api/errors/BadRequestError.d.ts +1 -2
- package/dist/api/errors/ForbiddenError.d.ts +1 -2
- package/dist/api/errors/InternalServerError.d.ts +1 -2
- package/dist/api/errors/NotFoundError.d.ts +1 -2
- package/dist/api/errors/ServiceUnavailableError.d.ts +1 -2
- package/dist/api/errors/TooManyRequestsError.d.ts +9 -0
- package/dist/api/errors/TooManyRequestsError.js +42 -0
- package/dist/api/errors/UnauthorizedError.d.ts +1 -2
- package/dist/api/errors/index.d.ts +1 -0
- package/dist/api/errors/index.js +1 -0
- package/dist/api/resources/dashboard/client/Client.d.ts +136 -0
- package/dist/api/resources/{userMemory → dashboard}/client/Client.js +191 -138
- package/dist/api/resources/dashboard/client/requests/CreateUserDashboardUserCreateUserPostRequest.d.ts +12 -0
- package/dist/api/resources/dashboard/client/requests/ListSourcesDashboardSourcesGetRequest.d.ts +16 -0
- package/dist/api/resources/dashboard/client/requests/index.d.ts +2 -0
- package/dist/api/resources/embeddings/client/Client.d.ts +40 -27
- package/dist/api/resources/embeddings/client/Client.js +68 -44
- package/dist/api/resources/embeddings/client/requests/BodyFilterRawEmbeddingsEndpointEmbeddingsFilterRawEmbeddingsPost.d.ts +24 -0
- package/dist/api/resources/embeddings/client/requests/BodyInsertRawEmbeddingsEndpointEmbeddingsInsertRawEmbeddingsPost.d.ts +27 -0
- package/dist/api/resources/embeddings/client/requests/BodySearchRawEmbeddingsEndpointEmbeddingsSearchRawEmbeddingsPost.d.ts +25 -0
- package/dist/api/resources/embeddings/client/requests/EmbeddingsDeleteRequest.d.ts +6 -5
- package/dist/api/resources/embeddings/client/requests/index.d.ts +3 -3
- package/dist/api/resources/fetch/client/Client.d.ts +96 -7
- package/dist/api/resources/fetch/client/Client.js +288 -10
- package/dist/api/resources/{sources/client/requests/SourcesGetGraphRelationsByIdRequest.d.ts → fetch/client/requests/FetchGraphRelationsBySourceIdRequest.d.ts} +2 -3
- package/dist/api/resources/{sources/client/requests/SourcesGetAllRequest.d.ts → fetch/client/requests/FetchSourcesRequest.d.ts} +2 -3
- package/dist/api/resources/fetch/client/requests/ListSourcesByIdRequest.d.ts +18 -0
- package/dist/api/resources/{upload/client/requests/UploadUpdateTextRequest.d.ts → fetch/client/requests/SourceFetchRequest.d.ts} +9 -10
- package/dist/api/resources/fetch/client/requests/index.d.ts +4 -1
- package/dist/api/resources/index.d.ts +10 -13
- package/dist/api/resources/index.js +11 -14
- package/dist/api/resources/search/client/Client.d.ts +50 -26
- package/dist/api/resources/search/client/Client.js +65 -35
- package/dist/api/resources/search/client/requests/FullTextSearchRequest.d.ts +6 -4
- package/dist/api/resources/search/client/requests/{SearchRequest.d.ts → HybridSearchRequest.d.ts} +13 -9
- package/dist/api/resources/search/client/requests/QnASearchRequest.d.ts +39 -0
- package/dist/api/resources/search/client/requests/index.d.ts +2 -2
- package/dist/api/resources/sources/client/Client.d.ts +11 -61
- package/dist/api/resources/sources/client/Client.js +14 -191
- package/dist/api/resources/sources/client/requests/SourceDeleteRequest.d.ts +17 -0
- package/dist/api/resources/sources/client/requests/index.d.ts +1 -3
- package/dist/api/resources/tenant/client/Client.d.ts +54 -38
- package/dist/api/resources/tenant/client/Client.js +67 -114
- package/dist/api/resources/tenant/client/requests/TenantCreateRequest.d.ts +20 -0
- package/dist/api/resources/tenant/client/requests/TenantStatsRequest.d.ts +1 -4
- package/dist/api/resources/tenant/client/requests/index.d.ts +1 -2
- package/dist/api/resources/upload/client/Client.d.ts +54 -428
- package/dist/api/resources/upload/client/Client.js +97 -1417
- package/dist/api/resources/upload/client/requests/{UploadUploadMarkdownRequest.d.ts → BodyAddMemoryMemoriesAddMemoryPost.d.ts} +7 -7
- package/dist/api/resources/upload/client/requests/BodyUploadAppIngestionUploadAppPost.d.ts +31 -0
- package/dist/api/resources/upload/client/requests/BodyUploadDocumentIngestionUploadDocumentPost.d.ts +22 -0
- package/dist/api/resources/upload/client/requests/UploadDeleteMemoryRequest.d.ts +18 -0
- package/dist/api/resources/upload/client/requests/UploadVerifyProcessingRequest.d.ts +1 -2
- package/dist/api/resources/upload/client/requests/index.d.ts +4 -16
- package/dist/api/types/AddMemoryResponse.d.ts +17 -0
- package/dist/api/types/ApiKeyInfo.d.ts +17 -0
- package/dist/api/types/AppSourcesUploadData.d.ts +10 -4
- package/dist/api/types/CollectionStats.d.ts +9 -0
- package/dist/api/types/CustomPropertyDefinition.d.ts +38 -0
- package/dist/api/types/DashboardApisResponse.d.ts +12 -0
- package/dist/api/types/DashboardSourcesResponse.d.ts +12 -0
- package/dist/api/types/DashboardTenantsResponse.d.ts +12 -0
- package/dist/api/types/DeleteResult.d.ts +14 -0
- package/dist/api/types/DeleteUserMemoryResponse.d.ts +1 -1
- package/dist/api/types/Entity.d.ts +2 -2
- package/dist/api/types/FetchMode.d.ts +12 -0
- package/dist/api/types/FetchMode.js +11 -0
- package/dist/api/types/GraphContext.d.ts +12 -0
- package/dist/api/types/Infra.d.ts +8 -0
- package/dist/api/types/InsertResult.d.ts +16 -0
- package/dist/api/types/MemoryItem.d.ts +41 -0
- package/dist/api/types/MemoryResultItem.d.ts +19 -0
- package/dist/api/types/MilvusDataType.d.ts +21 -0
- package/dist/api/types/MilvusDataType.js +20 -0
- package/dist/api/types/PathTriplet.d.ts +9 -0
- package/dist/api/types/ProcessingStatus.d.ts +16 -2
- package/dist/api/types/ProcessingStatus.js +12 -0
- package/dist/api/types/QnASearchResponse.d.ts +20 -0
- package/dist/api/types/RawEmbeddingDocument.d.ts +15 -0
- package/dist/api/types/RawEmbeddingSearchResult.d.ts +19 -0
- package/dist/api/types/RawEmbeddingVector.d.ts +12 -0
- package/dist/api/types/RelationEvidence.d.ts +8 -0
- package/dist/api/types/RetrievalResult.d.ts +11 -0
- package/dist/api/types/ScoredPathResponse.d.ts +11 -0
- package/dist/api/types/SearchMode.d.ts +11 -0
- package/dist/api/types/SearchMode.js +10 -0
- package/dist/api/types/SourceDeleteResponse.d.ts +14 -0
- package/dist/api/types/SourceDeleteResultItem.d.ts +14 -0
- package/dist/api/types/SourceFetchResponse.d.ts +26 -0
- package/dist/api/types/{GraphRelationsResponse.d.ts → SourceGraphRelationsResponse.d.ts} +2 -2
- package/dist/api/types/SourceListResponse.d.ts +11 -0
- package/dist/api/types/SourceModel.d.ts +5 -1
- package/dist/api/types/SourceStatus.d.ts +10 -0
- package/dist/api/types/SourceStatus.js +12 -0
- package/dist/api/types/SourceUploadResponse.d.ts +14 -0
- package/dist/api/types/SourceUploadResultItem.d.ts +14 -0
- package/dist/api/types/SupportedLlmProviders.d.ts +11 -0
- package/dist/api/types/SupportedLlmProviders.js +13 -0
- package/dist/api/types/TenantCreateResponse.d.ts +14 -0
- package/dist/api/types/TenantInfo.d.ts +11 -0
- package/dist/api/types/TenantMetadataSchemaInfo.d.ts +14 -0
- package/dist/api/types/TenantStatsResponse.d.ts +14 -0
- package/dist/api/types/{TripleWithEvidence.d.ts → TripletWithEvidence.d.ts} +1 -1
- package/dist/api/types/UserAssistantPair.d.ts +3 -0
- package/dist/api/types/{SearchChunk.d.ts → VectorStoreChunk.d.ts} +3 -6
- package/dist/api/types/index.d.ts +38 -31
- package/dist/api/types/index.js +38 -31
- package/package.json +30 -33
- package/dist/api/resources/document/client/Client.d.ts +0 -59
- package/dist/api/resources/document/client/Client.js +0 -132
- package/dist/api/resources/document/client/index.d.ts +0 -1
- package/dist/api/resources/embeddings/client/requests/EmbeddingsCreateCollectionRequest.d.ts +0 -13
- package/dist/api/resources/embeddings/client/requests/EmbeddingsSearchRequest.d.ts +0 -18
- package/dist/api/resources/embeddings/client/requests/GetEmbeddingsBasedOnChunkIdsRequest.d.ts +0 -18
- package/dist/api/resources/fetch/client/requests/FetchContentRequest.d.ts +0 -18
- package/dist/api/resources/search/client/requests/QnARequest.d.ts +0 -47
- package/dist/api/resources/sources/client/requests/SourceBodyParams.d.ts +0 -18
- package/dist/api/resources/tenant/client/requests/TenantDeleteSubTenantRequest.d.ts +0 -14
- package/dist/api/resources/tenant/client/requests/TenantGetSubTenantIdsRequest.d.ts +0 -12
- package/dist/api/resources/upload/client/requests/BodyBatchUpdateUploadBatchUpdatePatch.d.ts +0 -37
- package/dist/api/resources/upload/client/requests/BodyBatchUploadUploadBatchUploadPost.d.ts +0 -37
- package/dist/api/resources/upload/client/requests/BodyUpdateFileUploadUpdateDocumentPatch.d.ts +0 -38
- package/dist/api/resources/upload/client/requests/BodyUploadFilesUploadUploadDocumentPost.d.ts +0 -37
- package/dist/api/resources/upload/client/requests/EmbeddingsUpdateRequest.d.ts +0 -18
- package/dist/api/resources/upload/client/requests/EmbeddingsUploadRequest.d.ts +0 -21
- package/dist/api/resources/upload/client/requests/UploadBatchScrapeWebpageRequest.d.ts +0 -22
- package/dist/api/resources/upload/client/requests/UploadBatchUploadMarkdownRequest.d.ts +0 -22
- package/dist/api/resources/upload/client/requests/UploadBatchUploadTextRequest.d.ts +0 -22
- package/dist/api/resources/upload/client/requests/UploadScrapeWebpageRequest.d.ts +0 -25
- package/dist/api/resources/upload/client/requests/UploadUpdateMarkdownRequest.d.ts +0 -24
- package/dist/api/resources/upload/client/requests/UploadUpdateWebpageRequest.d.ts +0 -25
- package/dist/api/resources/upload/client/requests/UploadUploadAppSourcesRequest.d.ts +0 -20
- package/dist/api/resources/upload/client/requests/UploadUploadTextRequest.d.ts +0 -21
- package/dist/api/resources/user/client/Client.d.ts +0 -60
- package/dist/api/resources/user/client/Client.js +0 -152
- package/dist/api/resources/user/client/requests/BodyCreateTenantUserCreateTenantPost.d.ts +0 -15
- package/dist/api/resources/user/client/requests/index.d.ts +0 -1
- package/dist/api/resources/user/client/requests/index.js +0 -2
- package/dist/api/resources/user/index.d.ts +0 -1
- package/dist/api/resources/user/index.js +0 -17
- package/dist/api/resources/userMemory/client/Client.d.ts +0 -150
- package/dist/api/resources/userMemory/client/index.d.ts +0 -2
- package/dist/api/resources/userMemory/client/index.js +0 -17
- package/dist/api/resources/userMemory/client/requests/AddUserMemoryRequest.d.ts +0 -27
- package/dist/api/resources/userMemory/client/requests/RetrieveUserMemoryRequest.d.ts +0 -24
- package/dist/api/resources/userMemory/client/requests/UserMemoryDeleteUserMemoryRequest.d.ts +0 -19
- package/dist/api/resources/userMemory/client/requests/UserMemoryListUserMemoriesRequest.d.ts +0 -16
- package/dist/api/resources/userMemory/client/requests/index.d.ts +0 -4
- package/dist/api/resources/userMemory/client/requests/index.js +0 -2
- package/dist/api/resources/userMemory/index.d.ts +0 -1
- package/dist/api/resources/userMemory/index.js +0 -17
- package/dist/api/types/AddUserMemoryResponse.d.ts +0 -16
- package/dist/api/types/BatchUploadData.d.ts +0 -11
- package/dist/api/types/BodyScrapeWebpageUploadScrapeWebpagePost.d.ts +0 -5
- package/dist/api/types/BodyUpdateScrapeJobUploadUpdateWebpagePatch.d.ts +0 -5
- package/dist/api/types/DeleteMemoryRequest.d.ts +0 -11
- package/dist/api/types/DeleteSources.d.ts +0 -7
- package/dist/api/types/DeleteSubTenantData.d.ts +0 -15
- package/dist/api/types/EmbeddingsCreateCollectionData.d.ts +0 -13
- package/dist/api/types/EmbeddingsDeleteData.d.ts +0 -13
- package/dist/api/types/EmbeddingsGetData.d.ts +0 -13
- package/dist/api/types/EmbeddingsSearchData.d.ts +0 -13
- package/dist/api/types/ExtendedContext.d.ts +0 -8
- package/dist/api/types/FetchContentData.d.ts +0 -13
- package/dist/api/types/FileUploadResult.d.ts +0 -9
- package/dist/api/types/ListSourcesResponse.d.ts +0 -12
- package/dist/api/types/ListUserMemoriesResponse.d.ts +0 -13
- package/dist/api/types/MarkdownUploadRequest.d.ts +0 -22
- package/dist/api/types/RelatedChunk.d.ts +0 -9
- package/dist/api/types/RelatedChunk.js +0 -5
- package/dist/api/types/Relations.d.ts +0 -9
- package/dist/api/types/Relations.js +0 -5
- package/dist/api/types/RetrieveResponse.d.ts +0 -12
- package/dist/api/types/RetrieveResponse.js +0 -5
- package/dist/api/types/RetrieveUserMemoryResponse.d.ts +0 -15
- package/dist/api/types/RetrieveUserMemoryResponse.js +0 -5
- package/dist/api/types/SearchChunk.js +0 -5
- package/dist/api/types/SingleUploadData.d.ts +0 -10
- package/dist/api/types/SingleUploadData.js +0 -5
- package/dist/api/types/Source.d.ts +0 -19
- package/dist/api/types/Source.js +0 -5
- package/dist/api/types/SubTenantIdsData.d.ts +0 -17
- package/dist/api/types/SubTenantIdsData.js +0 -5
- package/dist/api/types/TenantCreateData.d.ts +0 -13
- package/dist/api/types/TenantCreateData.js +0 -5
- package/dist/api/types/TenantStats.d.ts +0 -15
- package/dist/api/types/TenantStats.js +0 -5
- package/dist/api/types/TripleWithEvidence.js +0 -5
- package/dist/api/types/UserMemory.d.ts +0 -12
- package/dist/api/types/UserMemory.js +0 -5
- package/dist/api/types/WebpageScrapeRequest.d.ts +0 -9
- package/dist/api/types/WebpageScrapeRequest.js +0 -5
- /package/dist/api/resources/{user → dashboard}/client/index.d.ts +0 -0
- /package/dist/api/resources/{user → dashboard}/client/index.js +0 -0
- /package/dist/api/resources/{embeddings/client/requests/EmbeddingsCreateCollectionRequest.js → dashboard/client/requests/CreateUserDashboardUserCreateUserPostRequest.js} +0 -0
- /package/dist/api/resources/{embeddings/client/requests/EmbeddingsSearchRequest.js → dashboard/client/requests/ListSourcesDashboardSourcesGetRequest.js} +0 -0
- /package/dist/api/resources/{document/client → dashboard/client/requests}/index.js +0 -0
- /package/dist/api/resources/{document → dashboard}/index.d.ts +0 -0
- /package/dist/api/resources/{document → dashboard}/index.js +0 -0
- /package/dist/api/resources/embeddings/client/requests/{GetEmbeddingsBasedOnChunkIdsRequest.js → BodyFilterRawEmbeddingsEndpointEmbeddingsFilterRawEmbeddingsPost.js} +0 -0
- /package/dist/api/resources/{fetch/client/requests/FetchContentRequest.js → embeddings/client/requests/BodyInsertRawEmbeddingsEndpointEmbeddingsInsertRawEmbeddingsPost.js} +0 -0
- /package/dist/api/resources/{search/client/requests/QnARequest.js → embeddings/client/requests/BodySearchRawEmbeddingsEndpointEmbeddingsSearchRawEmbeddingsPost.js} +0 -0
- /package/dist/api/resources/{search/client/requests/SearchRequest.js → fetch/client/requests/FetchGraphRelationsBySourceIdRequest.js} +0 -0
- /package/dist/api/resources/{sources/client/requests/SourceBodyParams.js → fetch/client/requests/FetchSourcesRequest.js} +0 -0
- /package/dist/api/resources/{sources/client/requests/SourcesGetAllRequest.js → fetch/client/requests/ListSourcesByIdRequest.js} +0 -0
- /package/dist/api/resources/{sources/client/requests/SourcesGetGraphRelationsByIdRequest.js → fetch/client/requests/SourceFetchRequest.js} +0 -0
- /package/dist/api/resources/{tenant/client/requests/TenantDeleteSubTenantRequest.js → search/client/requests/HybridSearchRequest.js} +0 -0
- /package/dist/api/resources/{tenant/client/requests/TenantGetSubTenantIdsRequest.js → search/client/requests/QnASearchRequest.js} +0 -0
- /package/dist/api/resources/{upload/client/requests/BodyBatchUpdateUploadBatchUpdatePatch.js → sources/client/requests/SourceDeleteRequest.js} +0 -0
- /package/dist/api/resources/{upload/client/requests/BodyBatchUploadUploadBatchUploadPost.js → tenant/client/requests/TenantCreateRequest.js} +0 -0
- /package/dist/api/resources/upload/client/requests/{BodyUpdateFileUploadUpdateDocumentPatch.js → BodyAddMemoryMemoriesAddMemoryPost.js} +0 -0
- /package/dist/api/resources/upload/client/requests/{BodyUploadFilesUploadUploadDocumentPost.js → BodyUploadAppIngestionUploadAppPost.js} +0 -0
- /package/dist/api/resources/upload/client/requests/{EmbeddingsUpdateRequest.js → BodyUploadDocumentIngestionUploadDocumentPost.js} +0 -0
- /package/dist/api/resources/upload/client/requests/{EmbeddingsUploadRequest.js → UploadDeleteMemoryRequest.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadBatchScrapeWebpageRequest.js → types/AddMemoryResponse.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadBatchUploadMarkdownRequest.js → types/ApiKeyInfo.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadBatchUploadTextRequest.js → types/CollectionStats.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadScrapeWebpageRequest.js → types/CustomPropertyDefinition.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadUpdateMarkdownRequest.js → types/DashboardApisResponse.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadUpdateTextRequest.js → types/DashboardSourcesResponse.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadUpdateWebpageRequest.js → types/DashboardTenantsResponse.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadUploadAppSourcesRequest.js → types/DeleteResult.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadUploadMarkdownRequest.js → types/GraphContext.js} +0 -0
- /package/dist/api/{resources/upload/client/requests/UploadUploadTextRequest.js → types/Infra.js} +0 -0
- /package/dist/api/{resources/user/client/requests/BodyCreateTenantUserCreateTenantPost.js → types/InsertResult.js} +0 -0
- /package/dist/api/{resources/userMemory/client/requests/AddUserMemoryRequest.js → types/MemoryItem.js} +0 -0
- /package/dist/api/{resources/userMemory/client/requests/RetrieveUserMemoryRequest.js → types/MemoryResultItem.js} +0 -0
- /package/dist/api/{resources/userMemory/client/requests/UserMemoryDeleteUserMemoryRequest.js → types/PathTriplet.js} +0 -0
- /package/dist/api/{resources/userMemory/client/requests/UserMemoryListUserMemoriesRequest.js → types/QnASearchResponse.js} +0 -0
- /package/dist/api/types/{AddUserMemoryResponse.js → RawEmbeddingDocument.js} +0 -0
- /package/dist/api/types/{BatchUploadData.js → RawEmbeddingSearchResult.js} +0 -0
- /package/dist/api/types/{BodyScrapeWebpageUploadScrapeWebpagePost.js → RawEmbeddingVector.js} +0 -0
- /package/dist/api/types/{BodyUpdateScrapeJobUploadUpdateWebpagePatch.js → RetrievalResult.js} +0 -0
- /package/dist/api/types/{DeleteMemoryRequest.js → ScoredPathResponse.js} +0 -0
- /package/dist/api/types/{DeleteSources.js → SourceDeleteResponse.js} +0 -0
- /package/dist/api/types/{DeleteSubTenantData.js → SourceDeleteResultItem.js} +0 -0
- /package/dist/api/types/{EmbeddingsCreateCollectionData.js → SourceFetchResponse.js} +0 -0
- /package/dist/api/types/{EmbeddingsDeleteData.js → SourceGraphRelationsResponse.js} +0 -0
- /package/dist/api/types/{EmbeddingsGetData.js → SourceListResponse.js} +0 -0
- /package/dist/api/types/{EmbeddingsSearchData.js → SourceUploadResponse.js} +0 -0
- /package/dist/api/types/{ExtendedContext.js → SourceUploadResultItem.js} +0 -0
- /package/dist/api/types/{FetchContentData.js → TenantCreateResponse.js} +0 -0
- /package/dist/api/types/{FileUploadResult.js → TenantInfo.js} +0 -0
- /package/dist/api/types/{GraphRelationsResponse.js → TenantMetadataSchemaInfo.js} +0 -0
- /package/dist/api/types/{ListSourcesResponse.js → TenantStatsResponse.js} +0 -0
- /package/dist/api/types/{ListUserMemoriesResponse.js → TripletWithEvidence.js} +0 -0
- /package/dist/api/types/{MarkdownUploadRequest.js → VectorStoreChunk.js} +0 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as CortexAI from "../../../../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* tenant_id: "tenant_id"
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface TenantCreateRequest {
|
|
12
|
+
/** Unique tenant identifier */
|
|
13
|
+
tenant_id: string;
|
|
14
|
+
/** True to create embeddings tenant */
|
|
15
|
+
is_embeddings_tenant?: boolean;
|
|
16
|
+
/** Embedding dimensions for embeddings tenant. Not required for non-embeddings (is_embeddings_tenant=False) tenants */
|
|
17
|
+
embeddings_dimension?: number;
|
|
18
|
+
/** Schema definition for tenant metadata fields. Each field can be configured for: filtering (enable_match), semantic search (enable_dense_embedding), and/or keyword search (enable_sparse_embedding). Fields with embeddings enabled must be VARCHAR type. */
|
|
19
|
+
tenant_metadata_schema?: CortexAI.CustomPropertyDefinition[];
|
|
20
|
+
}
|
|
@@ -4,13 +4,10 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
* tenant_id: "
|
|
8
|
-
* sub_tenant_id: "sub_tenant_4567"
|
|
7
|
+
* tenant_id: "tenant_id"
|
|
9
8
|
* }
|
|
10
9
|
*/
|
|
11
10
|
export interface TenantStatsRequest {
|
|
12
11
|
/** Unique identifier for the tenant/organization */
|
|
13
12
|
tenant_id: string;
|
|
14
|
-
/** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
|
|
15
|
-
sub_tenant_id?: string;
|
|
16
13
|
}
|
|
@@ -1,3 +1,2 @@
|
|
|
1
|
+
export { type TenantCreateRequest } from "./TenantCreateRequest.js";
|
|
1
2
|
export { type TenantStatsRequest } from "./TenantStatsRequest.js";
|
|
2
|
-
export { type TenantGetSubTenantIdsRequest } from "./TenantGetSubTenantIdsRequest.js";
|
|
3
|
-
export { type TenantDeleteSubTenantRequest } from "./TenantDeleteSubTenantRequest.js";
|
|
@@ -30,69 +30,12 @@ export declare class Upload {
|
|
|
30
30
|
protected readonly _options: Upload.Options;
|
|
31
31
|
constructor(_options?: Upload.Options);
|
|
32
32
|
/**
|
|
33
|
-
* Upload
|
|
33
|
+
* Upload one or more documents for ingestion.
|
|
34
|
+
* Supports both single and batch uploads.
|
|
35
|
+
* For single file: send one file with the 'files' field.
|
|
36
|
+
* For batch: send multiple files with the 'files' field (FastAPI will parse as list).
|
|
34
37
|
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* The system automatically handles file parsing, content extraction, and indexing across all uploaded documents. You'll receive confirmation once all files are queued for processing.
|
|
38
|
-
*
|
|
39
|
-
* @param {CortexAI.BodyBatchUploadUploadBatchUploadPost} request
|
|
40
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
41
|
-
*
|
|
42
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
43
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
44
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
45
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
46
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
47
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
48
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
49
|
-
*
|
|
50
|
-
* @example
|
|
51
|
-
* import { createReadStream } from "fs";
|
|
52
|
-
* await client.upload.batchUpload({
|
|
53
|
-
* files: [fs.createReadStream("/path/to/your/file")],
|
|
54
|
-
* tenant_id: "tenant_1234",
|
|
55
|
-
* sub_tenant_id: "sub_tenant_4567"
|
|
56
|
-
* })
|
|
57
|
-
*/
|
|
58
|
-
batchUpload(request: CortexAI.BodyBatchUploadUploadBatchUploadPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.BatchUploadData>;
|
|
59
|
-
private __batchUpload;
|
|
60
|
-
/**
|
|
61
|
-
* Update multiple existing documents with new content and metadata.
|
|
62
|
-
*
|
|
63
|
-
* Use this endpoint when you need to replace or modify several documents that are already in your knowledge base. Each file must correspond to an existing source ID, ensuring that updates are applied to the correct documents.
|
|
64
|
-
*
|
|
65
|
-
* The system processes updates asynchronously, allowing you to continue working while your documents are re-indexed. Track the progress using the returned file IDs to know when updates are complete.
|
|
66
|
-
*
|
|
67
|
-
* @param {CortexAI.BodyBatchUpdateUploadBatchUpdatePatch} request
|
|
68
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
69
|
-
*
|
|
70
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
71
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
72
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
73
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
74
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
75
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
76
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
77
|
-
*
|
|
78
|
-
* @example
|
|
79
|
-
* import { createReadStream } from "fs";
|
|
80
|
-
* await client.upload.batchUpdate({
|
|
81
|
-
* files: [fs.createReadStream("/path/to/your/file")],
|
|
82
|
-
* tenant_id: "tenant_1234",
|
|
83
|
-
* sub_tenant_id: "sub_tenant_4567"
|
|
84
|
-
* })
|
|
85
|
-
*/
|
|
86
|
-
batchUpdate(request: CortexAI.BodyBatchUpdateUploadBatchUpdatePatch, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.BatchUploadData>;
|
|
87
|
-
private __batchUpdate;
|
|
88
|
-
/**
|
|
89
|
-
* Upload a single document for processing and indexing into your knowledge base.
|
|
90
|
-
*
|
|
91
|
-
* This endpoint accepts documents in various formats and processes them for search and retrieval. You can include custom metadata to help organize and categorize your content.
|
|
92
|
-
*
|
|
93
|
-
* The system extracts text content, processes it asynchronously, and makes it available for search queries. You can track the processing status using the returned file ID.
|
|
94
|
-
*
|
|
95
|
-
* @param {CortexAI.BodyUploadFilesUploadUploadDocumentPost} request
|
|
38
|
+
* @param {CortexAI.BodyUploadDocumentIngestionUploadDocumentPost} request
|
|
96
39
|
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
97
40
|
*
|
|
98
41
|
* @throws {@link CortexAI.BadRequestError}
|
|
@@ -106,50 +49,17 @@ export declare class Upload {
|
|
|
106
49
|
* @example
|
|
107
50
|
* import { createReadStream } from "fs";
|
|
108
51
|
* await client.upload.uploadDocument({
|
|
109
|
-
*
|
|
110
|
-
* tenant_id: "
|
|
111
|
-
* sub_tenant_id: "sub_tenant_4567"
|
|
52
|
+
* files: [fs.createReadStream("/path/to/your/file")],
|
|
53
|
+
* tenant_id: "tenant_id"
|
|
112
54
|
* })
|
|
113
55
|
*/
|
|
114
|
-
uploadDocument(request: CortexAI.
|
|
56
|
+
uploadDocument(request: CortexAI.BodyUploadDocumentIngestionUploadDocumentPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SourceUploadResponse>;
|
|
115
57
|
private __uploadDocument;
|
|
116
58
|
/**
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* This endpoint allows you to update a specific document that's already in your knowledge base. Provide the source ID of the document you want to modify, along with the new file content.
|
|
120
|
-
*
|
|
121
|
-
* The system will process your update asynchronously and re-index the document with the new content. You can monitor the progress using the returned file ID.
|
|
59
|
+
* Upload structured sources generated by first-party or third-party apps.
|
|
60
|
+
* Supports both single and batch uploads.
|
|
122
61
|
*
|
|
123
|
-
* @param {CortexAI.
|
|
124
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
125
|
-
*
|
|
126
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
127
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
128
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
129
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
130
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
131
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
132
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
133
|
-
*
|
|
134
|
-
* @example
|
|
135
|
-
* import { createReadStream } from "fs";
|
|
136
|
-
* await client.upload.updateDocument({
|
|
137
|
-
* file: fs.createReadStream("/path/to/your/file"),
|
|
138
|
-
* source_id: "CortexDoc1234",
|
|
139
|
-
* tenant_id: "tenant_1234",
|
|
140
|
-
* sub_tenant_id: "sub_tenant_4567"
|
|
141
|
-
* })
|
|
142
|
-
*/
|
|
143
|
-
updateDocument(request: CortexAI.BodyUpdateFileUploadUpdateDocumentPatch, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
|
|
144
|
-
private __updateDocument;
|
|
145
|
-
/**
|
|
146
|
-
* Upload structured data from applications or APIs for indexing.
|
|
147
|
-
*
|
|
148
|
-
* This endpoint is designed for importing data from applications. If you are specifically using Cortex to provide search to an application, you should prefer this endpoint. It accepts structured source objects and allows you to clearly define contents of attachments
|
|
149
|
-
*
|
|
150
|
-
* The system processes each source asynchronously and makes the content available for search and retrieval. Use this when you need to integrate search and indexing from data in your applications into your knowledge base.
|
|
151
|
-
*
|
|
152
|
-
* @param {CortexAI.UploadUploadAppSourcesRequest} request
|
|
62
|
+
* @param {CortexAI.BodyUploadAppIngestionUploadAppPost} request
|
|
153
63
|
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
154
64
|
*
|
|
155
65
|
* @throws {@link CortexAI.BadRequestError}
|
|
@@ -162,193 +72,24 @@ export declare class Upload {
|
|
|
162
72
|
*
|
|
163
73
|
* @example
|
|
164
74
|
* await client.upload.uploadAppSources({
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
75
|
+
* app_sources: {
|
|
76
|
+
* id: "id",
|
|
77
|
+
* tenant_id: "tenant_id",
|
|
78
|
+
* sub_tenant_id: "sub_tenant_id"
|
|
79
|
+
* },
|
|
80
|
+
* tenant_id: "tenant_id"
|
|
168
81
|
* })
|
|
169
82
|
*/
|
|
170
|
-
uploadAppSources(request: CortexAI.
|
|
83
|
+
uploadAppSources(request: CortexAI.BodyUploadAppIngestionUploadAppPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.AppSourcesUploadData>;
|
|
171
84
|
private __uploadAppSources;
|
|
172
85
|
/**
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
* This endpoint accepts plain text or markdown-formatted content that you want to add to your knowledge base. It's perfect for notes, documentation, articles, or any text-based content you want to make searchable.
|
|
176
|
-
*
|
|
177
|
-
* You can include custom metadata to help organize and categorize your content. You can track the processing status using the returned file ID.
|
|
178
|
-
*
|
|
179
|
-
* @param {CortexAI.UploadUploadMarkdownRequest} request
|
|
180
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
181
|
-
*
|
|
182
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
183
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
184
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
185
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
186
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
187
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
188
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
189
|
-
*
|
|
190
|
-
* @example
|
|
191
|
-
* await client.upload.uploadMarkdown({
|
|
192
|
-
* tenant_id: "tenant_1234",
|
|
193
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
194
|
-
* body: {
|
|
195
|
-
* content: "<content>"
|
|
196
|
-
* }
|
|
197
|
-
* })
|
|
198
|
-
*/
|
|
199
|
-
uploadMarkdown(request: CortexAI.UploadUploadMarkdownRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
|
|
200
|
-
private __uploadMarkdown;
|
|
201
|
-
/**
|
|
202
|
-
* Upload text or markdown content directly for processing.
|
|
203
|
-
*
|
|
204
|
-
* This endpoint accepts plain text or markdown-formatted content that you want to add to your knowledge base. It's perfect for notes, documentation, articles, or any text-based content you want to make searchable.
|
|
205
|
-
*
|
|
206
|
-
* You can include custom metadata to help organize and categorize your content. You can track the processing status using the returned file ID.
|
|
207
|
-
*
|
|
208
|
-
* @param {CortexAI.UploadUploadTextRequest} request
|
|
209
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
210
|
-
*
|
|
211
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
212
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
213
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
214
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
215
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
216
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
217
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
218
|
-
*
|
|
219
|
-
* @example
|
|
220
|
-
* await client.upload.uploadText({
|
|
221
|
-
* tenant_id: "tenant_1234",
|
|
222
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
223
|
-
* body: {
|
|
224
|
-
* content: "<content>"
|
|
225
|
-
* }
|
|
226
|
-
* })
|
|
227
|
-
*/
|
|
228
|
-
uploadText(request: CortexAI.UploadUploadTextRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
|
|
229
|
-
private __uploadText;
|
|
230
|
-
/**
|
|
231
|
-
* Update existing text or markdown content with new information.
|
|
232
|
-
*
|
|
233
|
-
* This endpoint allows you to modify text or markdown content that's already in your knowledge base. Provide the source ID of the content you want to update, along with the new text.
|
|
234
|
-
*
|
|
235
|
-
* The system will reprocess and re-index the updated content asynchronously. Use this when you need to correct information, add details, or refresh existing documentation.
|
|
236
|
-
*
|
|
237
|
-
* @param {CortexAI.UploadUpdateMarkdownRequest} request
|
|
238
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
239
|
-
*
|
|
240
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
241
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
242
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
243
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
244
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
245
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
246
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
247
|
-
*
|
|
248
|
-
* @example
|
|
249
|
-
* await client.upload.updateMarkdown({
|
|
250
|
-
* source_id: "CortexDoc1234",
|
|
251
|
-
* tenant_id: "tenant_1234",
|
|
252
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
253
|
-
* body: {
|
|
254
|
-
* content: "<content>"
|
|
255
|
-
* }
|
|
256
|
-
* })
|
|
257
|
-
*/
|
|
258
|
-
updateMarkdown(request: CortexAI.UploadUpdateMarkdownRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
|
|
259
|
-
private __updateMarkdown;
|
|
260
|
-
/**
|
|
261
|
-
* Update existing text or markdown content with new information.
|
|
262
|
-
*
|
|
263
|
-
* This endpoint allows you to modify text or markdown content that's already in your knowledge base. Provide the source ID of the content you want to update, along with the new text.
|
|
264
|
-
*
|
|
265
|
-
* The system will reprocess and re-index the updated content asynchronously. Use this when you need to correct information, add details, or refresh existing documentation.
|
|
266
|
-
*
|
|
267
|
-
* @param {CortexAI.UploadUpdateTextRequest} request
|
|
268
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
269
|
-
*
|
|
270
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
271
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
272
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
273
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
274
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
275
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
276
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
277
|
-
*
|
|
278
|
-
* @example
|
|
279
|
-
* await client.upload.updateText({
|
|
280
|
-
* source_id: "CortexDoc1234",
|
|
281
|
-
* tenant_id: "tenant_1234",
|
|
282
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
283
|
-
* body: {
|
|
284
|
-
* content: "<content>"
|
|
285
|
-
* }
|
|
286
|
-
* })
|
|
287
|
-
*/
|
|
288
|
-
updateText(request: CortexAI.UploadUpdateTextRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
|
|
289
|
-
private __updateText;
|
|
290
|
-
/**
|
|
291
|
-
* Upload multiple markdown/text documents simultaneously for efficient bulk processing.
|
|
292
|
-
*
|
|
293
|
-
* This endpoint allows you to upload several markdown or text contents at once. Each content item gets processed asynchronously, and you can track the progress using their returned file IDs.
|
|
294
|
-
*
|
|
295
|
-
* @param {CortexAI.UploadBatchUploadMarkdownRequest} request
|
|
296
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
297
|
-
*
|
|
298
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
299
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
300
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
301
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
302
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
303
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
304
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
305
|
-
*
|
|
306
|
-
* @example
|
|
307
|
-
* await client.upload.batchUploadMarkdown({
|
|
308
|
-
* tenant_id: "tenant_1234",
|
|
309
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
310
|
-
* body: [{
|
|
311
|
-
* content: "<content>"
|
|
312
|
-
* }]
|
|
313
|
-
* })
|
|
314
|
-
*/
|
|
315
|
-
batchUploadMarkdown(request: CortexAI.UploadBatchUploadMarkdownRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.BatchUploadData>;
|
|
316
|
-
private __batchUploadMarkdown;
|
|
317
|
-
/**
|
|
318
|
-
* Upload multiple markdown/text documents simultaneously for efficient bulk processing.
|
|
319
|
-
*
|
|
320
|
-
* This endpoint allows you to upload several markdown or text contents at once. Each content item gets processed asynchronously, and you can track the progress using their returned file IDs.
|
|
321
|
-
*
|
|
322
|
-
* @param {CortexAI.UploadBatchUploadTextRequest} request
|
|
323
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
324
|
-
*
|
|
325
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
326
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
327
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
328
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
329
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
330
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
331
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
332
|
-
*
|
|
333
|
-
* @example
|
|
334
|
-
* await client.upload.batchUploadText({
|
|
335
|
-
* tenant_id: "tenant_1234",
|
|
336
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
337
|
-
* body: [{
|
|
338
|
-
* content: "<content>"
|
|
339
|
-
* }]
|
|
340
|
-
* })
|
|
341
|
-
*/
|
|
342
|
-
batchUploadText(request: CortexAI.UploadBatchUploadTextRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.BatchUploadData>;
|
|
343
|
-
private __batchUploadText;
|
|
344
|
-
/**
|
|
345
|
-
* Upload pre-computed embeddings for advanced similarity search.
|
|
86
|
+
* Check the current processing status of your uploaded content.
|
|
346
87
|
*
|
|
347
|
-
* This endpoint
|
|
88
|
+
* This endpoint allows you to monitor the progress of documents, text, or other content you've uploaded. Simply provide the file ID to see whether processing is complete, still in progress, or if any errors occurred.
|
|
348
89
|
*
|
|
349
|
-
*
|
|
90
|
+
* Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.
|
|
350
91
|
*
|
|
351
|
-
* @param {CortexAI.
|
|
92
|
+
* @param {CortexAI.UploadVerifyProcessingRequest} request
|
|
352
93
|
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
353
94
|
*
|
|
354
95
|
* @throws {@link CortexAI.BadRequestError}
|
|
@@ -360,48 +101,32 @@ export declare class Upload {
|
|
|
360
101
|
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
361
102
|
*
|
|
362
103
|
* @example
|
|
363
|
-
* await client.upload.
|
|
364
|
-
*
|
|
365
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
366
|
-
* embeddings: [[0.123413, 0.655367, 0.987654, 0.123456, 0.789012], [0.123413, 0.655367, 0.987654, 0.123456, 0.789012]]
|
|
104
|
+
* await client.upload.verifyProcessing({
|
|
105
|
+
* file_id: "file_id"
|
|
367
106
|
* })
|
|
368
107
|
*/
|
|
369
|
-
|
|
370
|
-
private
|
|
108
|
+
verifyProcessing(request: CortexAI.UploadVerifyProcessingRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.ProcessingStatus>;
|
|
109
|
+
private __verifyProcessing;
|
|
371
110
|
/**
|
|
372
|
-
*
|
|
111
|
+
* Add memories for indexing and retrieval.
|
|
373
112
|
*
|
|
374
|
-
*
|
|
113
|
+
* This API provides a unified entry point for ingesting various types of content:
|
|
375
114
|
*
|
|
376
|
-
*
|
|
115
|
+
* **Content Types Supported:**
|
|
116
|
+
* - Raw text content (`text` field)
|
|
117
|
+
* - Markdown formatted content (`text` + `is_markdown=true`)
|
|
118
|
+
* - User/assistant conversation pairs (`user_assistant_pairs` field)
|
|
377
119
|
*
|
|
378
|
-
*
|
|
379
|
-
*
|
|
120
|
+
* **Key Features:**
|
|
121
|
+
* - **Inference Mode (`infer=true`)**: When enabled, the system extracts additional
|
|
122
|
+
* insights and implicit information from your content. Useful for conversation
|
|
123
|
+
* analysis and knowledge extraction.
|
|
124
|
+
* - **Direct Mode (`infer=false`)**: Content is chunked and indexed as-is without
|
|
125
|
+
* additional processing.
|
|
380
126
|
*
|
|
381
|
-
*
|
|
382
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
383
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
384
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
385
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
386
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
387
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
127
|
+
* Use `/ingestion/verify-processing` endpoint to check the processing status.
|
|
388
128
|
*
|
|
389
|
-
* @
|
|
390
|
-
* await client.upload.updateEmbeddings({
|
|
391
|
-
* tenant_id: "tenant_1234",
|
|
392
|
-
* sub_tenant_id: "sub_tenant_4567"
|
|
393
|
-
* })
|
|
394
|
-
*/
|
|
395
|
-
updateEmbeddings(request: CortexAI.EmbeddingsUpdateRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
|
|
396
|
-
private __updateEmbeddings;
|
|
397
|
-
/**
|
|
398
|
-
* Extract and index content from web pages automatically.
|
|
399
|
-
*
|
|
400
|
-
* This endpoint initiates web scraping for the specified URL, extracting the main content, text, and structure from the webpage. It's perfect for capturing articles, documentation, or any web content you want to include in your knowledge base.
|
|
401
|
-
*
|
|
402
|
-
* The system processes the webpage content asynchronously, cleaning and structuring the information for optimal search and retrieval. Use this when you need to add web content without manual copying and pasting.
|
|
403
|
-
*
|
|
404
|
-
* @param {CortexAI.UploadScrapeWebpageRequest} request
|
|
129
|
+
* @param {CortexAI.BodyAddMemoryMemoriesAddMemoryPost} request
|
|
405
130
|
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
406
131
|
*
|
|
407
132
|
* @throws {@link CortexAI.BadRequestError}
|
|
@@ -413,24 +138,23 @@ export declare class Upload {
|
|
|
413
138
|
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
414
139
|
*
|
|
415
140
|
* @example
|
|
416
|
-
* await client.upload.
|
|
417
|
-
*
|
|
418
|
-
* tenant_id: "
|
|
419
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
420
|
-
* file_id: "CortexDoc1234",
|
|
421
|
-
* body: {}
|
|
141
|
+
* await client.upload.addMemory({
|
|
142
|
+
* memories: [{}],
|
|
143
|
+
* tenant_id: "tenant_id"
|
|
422
144
|
* })
|
|
423
145
|
*/
|
|
424
|
-
|
|
425
|
-
private
|
|
146
|
+
addMemory(request: CortexAI.BodyAddMemoryMemoriesAddMemoryPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.AddMemoryResponse>;
|
|
147
|
+
private __addMemory;
|
|
426
148
|
/**
|
|
427
|
-
*
|
|
149
|
+
* Permanently remove a specific memory from storage.
|
|
428
150
|
*
|
|
429
|
-
*
|
|
151
|
+
* This API allows you to delete a memory by its unique identifier.
|
|
152
|
+
* Once deleted, the memory cannot be recovered, so use this operation carefully.
|
|
430
153
|
*
|
|
431
|
-
*
|
|
154
|
+
* The memory will be removed from your tenant's storage and will no longer
|
|
155
|
+
* appear in search results or memory listings.
|
|
432
156
|
*
|
|
433
|
-
* @param {CortexAI.
|
|
157
|
+
* @param {CortexAI.UploadDeleteMemoryRequest} request
|
|
434
158
|
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
435
159
|
*
|
|
436
160
|
* @throws {@link CortexAI.BadRequestError}
|
|
@@ -442,110 +166,12 @@ export declare class Upload {
|
|
|
442
166
|
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
443
167
|
*
|
|
444
168
|
* @example
|
|
445
|
-
* await client.upload.updateWebpage({
|
|
446
|
-
* web_url: "https://www.usecortex.ai/",
|
|
447
|
-
* source_id: "CortexDoc1234",
|
|
448
|
-
* tenant_id: "tenant_1234",
|
|
449
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
450
|
-
* body: {}
|
|
451
|
-
* })
|
|
452
|
-
*/
|
|
453
|
-
updateWebpage(request: CortexAI.UploadUpdateWebpageRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
|
|
454
|
-
private __updateWebpage;
|
|
455
|
-
/**
|
|
456
|
-
* Extract and index content from multiple web pages simultaneously.
|
|
457
|
-
*
|
|
458
|
-
* This endpoint initiates web scraping for multiple URLs at once, extracting the main content, text, and structure from each webpage. It's perfect for capturing multiple articles, documentation pages, or any web content you want to include in your knowledge base.
|
|
459
|
-
*
|
|
460
|
-
* The system processes all webpage content asynchronously, cleaning and structuring the information for optimal search and retrieval.
|
|
461
|
-
*
|
|
462
|
-
* @param {CortexAI.UploadBatchScrapeWebpageRequest} request
|
|
463
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
464
|
-
*
|
|
465
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
466
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
467
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
468
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
469
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
470
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
471
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
472
|
-
*
|
|
473
|
-
* @example
|
|
474
|
-
* await client.upload.batchScrapeWebpage({
|
|
475
|
-
* tenant_id: "tenant_1234",
|
|
476
|
-
* sub_tenant_id: "sub_tenant_4567",
|
|
477
|
-
* body: [{
|
|
478
|
-
* web_url: "https://www.usecortex.ai/"
|
|
479
|
-
* }]
|
|
480
|
-
* })
|
|
481
|
-
*/
|
|
482
|
-
batchScrapeWebpage(request: CortexAI.UploadBatchScrapeWebpageRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.BatchUploadData>;
|
|
483
|
-
private __batchScrapeWebpage;
|
|
484
|
-
/**
|
|
485
|
-
* Remove documents and content from your knowledge base.
|
|
486
|
-
*
|
|
487
|
-
* This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
|
|
488
|
-
*
|
|
489
|
-
* Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
|
|
490
|
-
*
|
|
491
|
-
* @param {CortexAI.DeleteMemoryRequest} request
|
|
492
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
493
|
-
*
|
|
494
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
495
|
-
*
|
|
496
|
-
* @example
|
|
497
|
-
* await client.upload.deleteSource({
|
|
498
|
-
* tenant_id: "tenant_1234",
|
|
499
|
-
* source_ids: ["CortexDoc1234", "CortexDoc4567"]
|
|
500
|
-
* })
|
|
501
|
-
*/
|
|
502
|
-
deleteSource(request: CortexAI.DeleteMemoryRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<unknown>;
|
|
503
|
-
private __deleteSource;
|
|
504
|
-
/**
|
|
505
|
-
* Remove documents and content from your knowledge base.
|
|
506
|
-
*
|
|
507
|
-
* This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
|
|
508
|
-
*
|
|
509
|
-
* Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
|
|
510
|
-
*
|
|
511
|
-
* @param {CortexAI.DeleteMemoryRequest} request
|
|
512
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
513
|
-
*
|
|
514
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
515
|
-
*
|
|
516
|
-
* @example
|
|
517
169
|
* await client.upload.deleteMemory({
|
|
518
|
-
* tenant_id: "
|
|
519
|
-
*
|
|
170
|
+
* tenant_id: "tenant_id",
|
|
171
|
+
* memory_id: "memory_id"
|
|
520
172
|
* })
|
|
521
173
|
*/
|
|
522
|
-
deleteMemory(request: CortexAI.
|
|
174
|
+
deleteMemory(request: CortexAI.UploadDeleteMemoryRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.DeleteUserMemoryResponse>;
|
|
523
175
|
private __deleteMemory;
|
|
524
|
-
/**
|
|
525
|
-
* Check the current processing status of your uploaded content.
|
|
526
|
-
*
|
|
527
|
-
* This endpoint allows you to monitor the progress of documents, text, or other content you've uploaded. Simply provide the file ID to see whether processing is complete, still in progress, or if any errors occurred.
|
|
528
|
-
*
|
|
529
|
-
* Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.
|
|
530
|
-
*
|
|
531
|
-
* @param {CortexAI.UploadVerifyProcessingRequest} request
|
|
532
|
-
* @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
|
|
533
|
-
*
|
|
534
|
-
* @throws {@link CortexAI.BadRequestError}
|
|
535
|
-
* @throws {@link CortexAI.UnauthorizedError}
|
|
536
|
-
* @throws {@link CortexAI.ForbiddenError}
|
|
537
|
-
* @throws {@link CortexAI.NotFoundError}
|
|
538
|
-
* @throws {@link CortexAI.UnprocessableEntityError}
|
|
539
|
-
* @throws {@link CortexAI.InternalServerError}
|
|
540
|
-
* @throws {@link CortexAI.ServiceUnavailableError}
|
|
541
|
-
*
|
|
542
|
-
* @example
|
|
543
|
-
* await client.upload.verifyProcessing({
|
|
544
|
-
* file_id: "CortexDoc1234",
|
|
545
|
-
* tenant_id: "tenant_1234"
|
|
546
|
-
* })
|
|
547
|
-
*/
|
|
548
|
-
verifyProcessing(request: CortexAI.UploadVerifyProcessingRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.ProcessingStatus>;
|
|
549
|
-
private __verifyProcessing;
|
|
550
176
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
551
177
|
}
|