@gpt-platform/client 0.7.0 → 0.7.1
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/index.d.mts +248 -7
- package/dist/index.d.ts +248 -7
- package/dist/index.js +131 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +131 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -606,7 +606,7 @@ declare class BrowserApiKeyError extends Error {
|
|
|
606
606
|
}
|
|
607
607
|
|
|
608
608
|
/** SDK version — updated automatically by mix update.sdks */
|
|
609
|
-
declare const SDK_VERSION = "0.7.
|
|
609
|
+
declare const SDK_VERSION = "0.7.1";
|
|
610
610
|
/** Default API version sent in every request — updated automatically by mix update.sdks */
|
|
611
611
|
declare const DEFAULT_API_VERSION = "2026-03-11";
|
|
612
612
|
|
|
@@ -3232,7 +3232,26 @@ type ProcessingActivity = {
|
|
|
3232
3232
|
* An attributes object for a processing_activity
|
|
3233
3233
|
*/
|
|
3234
3234
|
attributes?: {
|
|
3235
|
-
|
|
3235
|
+
/**
|
|
3236
|
+
* EphiAsset IDs linked to this processing activity. Field included by default.
|
|
3237
|
+
*/
|
|
3238
|
+
asset_ids?: Array<string> | null | unknown;
|
|
3239
|
+
/**
|
|
3240
|
+
* Whether this processing activity involves ePHI. Field included by default.
|
|
3241
|
+
*/
|
|
3242
|
+
ephi_classification?: "contains_ephi" | "no_ephi" | unknown;
|
|
3243
|
+
/**
|
|
3244
|
+
* Last review date for this processing activity. Field included by default.
|
|
3245
|
+
*/
|
|
3246
|
+
last_reviewed_at?: string | null | unknown;
|
|
3247
|
+
/**
|
|
3248
|
+
* HIPAA minimum necessary standard justification. Field included by default.
|
|
3249
|
+
*/
|
|
3250
|
+
minimum_necessary_justification?: string | null | unknown;
|
|
3251
|
+
/**
|
|
3252
|
+
* How often this activity should be reviewed (days). Field included by default.
|
|
3253
|
+
*/
|
|
3254
|
+
review_frequency_days?: number | null | unknown;
|
|
3236
3255
|
};
|
|
3237
3256
|
id: string;
|
|
3238
3257
|
/**
|
|
@@ -4525,6 +4544,52 @@ type WatcherClaim = {
|
|
|
4525
4544
|
};
|
|
4526
4545
|
type: string;
|
|
4527
4546
|
};
|
|
4547
|
+
/**
|
|
4548
|
+
* A "Resource object" representing a section-document
|
|
4549
|
+
*/
|
|
4550
|
+
type SectionDocument = {
|
|
4551
|
+
/**
|
|
4552
|
+
* An attributes object for a section-document
|
|
4553
|
+
*/
|
|
4554
|
+
attributes?: {
|
|
4555
|
+
/**
|
|
4556
|
+
* Field included by default.
|
|
4557
|
+
*/
|
|
4558
|
+
doc_path?: string | null | unknown;
|
|
4559
|
+
/**
|
|
4560
|
+
* Field included by default.
|
|
4561
|
+
*/
|
|
4562
|
+
format?: "markdown" | "mdx" | "html" | "text" | "rst" | unknown;
|
|
4563
|
+
/**
|
|
4564
|
+
* Field included by default.
|
|
4565
|
+
*/
|
|
4566
|
+
indexed_at?: unknown;
|
|
4567
|
+
/**
|
|
4568
|
+
* Field included by default.
|
|
4569
|
+
*/
|
|
4570
|
+
section_count?: number | null | unknown;
|
|
4571
|
+
/**
|
|
4572
|
+
* Field included by default.
|
|
4573
|
+
*/
|
|
4574
|
+
source_id?: string | null | unknown;
|
|
4575
|
+
/**
|
|
4576
|
+
* Field included by default.
|
|
4577
|
+
*/
|
|
4578
|
+
source_type: "extraction" | "crawler" | "knowledge_file" | "direct";
|
|
4579
|
+
/**
|
|
4580
|
+
* Field included by default.
|
|
4581
|
+
*/
|
|
4582
|
+
source_url?: string | null | unknown;
|
|
4583
|
+
};
|
|
4584
|
+
id: string;
|
|
4585
|
+
/**
|
|
4586
|
+
* A relationships object for a section-document
|
|
4587
|
+
*/
|
|
4588
|
+
relationships?: {
|
|
4589
|
+
[key: string]: never;
|
|
4590
|
+
};
|
|
4591
|
+
type: string;
|
|
4592
|
+
};
|
|
4528
4593
|
/**
|
|
4529
4594
|
* A "Resource object" representing a tenant
|
|
4530
4595
|
*/
|
|
@@ -6026,6 +6091,64 @@ type PermissionMeta = {
|
|
|
6026
6091
|
};
|
|
6027
6092
|
type: string;
|
|
6028
6093
|
};
|
|
6094
|
+
/**
|
|
6095
|
+
* A "Resource object" representing a document-section
|
|
6096
|
+
*/
|
|
6097
|
+
type DocumentSection = {
|
|
6098
|
+
/**
|
|
6099
|
+
* An attributes object for a document-section
|
|
6100
|
+
*/
|
|
6101
|
+
attributes?: {
|
|
6102
|
+
/**
|
|
6103
|
+
* Field included by default.
|
|
6104
|
+
*/
|
|
6105
|
+
content_preview?: string | null | unknown;
|
|
6106
|
+
/**
|
|
6107
|
+
* Field included by default.
|
|
6108
|
+
*/
|
|
6109
|
+
doc_path: string;
|
|
6110
|
+
/**
|
|
6111
|
+
* Field included by default.
|
|
6112
|
+
*/
|
|
6113
|
+
level: number;
|
|
6114
|
+
/**
|
|
6115
|
+
* Field included by default.
|
|
6116
|
+
*/
|
|
6117
|
+
parent_stable_id?: string | null | unknown;
|
|
6118
|
+
/**
|
|
6119
|
+
* Field included by default.
|
|
6120
|
+
*/
|
|
6121
|
+
position?: number | null | unknown;
|
|
6122
|
+
/**
|
|
6123
|
+
* Field included by default.
|
|
6124
|
+
*/
|
|
6125
|
+
references?: Array<string> | null | unknown;
|
|
6126
|
+
/**
|
|
6127
|
+
* Field included by default.
|
|
6128
|
+
*/
|
|
6129
|
+
stable_id: string;
|
|
6130
|
+
/**
|
|
6131
|
+
* Field included by default.
|
|
6132
|
+
*/
|
|
6133
|
+
summary?: string | null | unknown;
|
|
6134
|
+
/**
|
|
6135
|
+
* Field included by default.
|
|
6136
|
+
*/
|
|
6137
|
+
tags?: Array<string> | null | unknown;
|
|
6138
|
+
/**
|
|
6139
|
+
* Field included by default.
|
|
6140
|
+
*/
|
|
6141
|
+
title: string;
|
|
6142
|
+
};
|
|
6143
|
+
id: string;
|
|
6144
|
+
/**
|
|
6145
|
+
* A relationships object for a document-section
|
|
6146
|
+
*/
|
|
6147
|
+
relationships?: {
|
|
6148
|
+
[key: string]: never;
|
|
6149
|
+
};
|
|
6150
|
+
type: string;
|
|
6151
|
+
};
|
|
6029
6152
|
/**
|
|
6030
6153
|
* A "Resource object" representing a clinical-delivery
|
|
6031
6154
|
*/
|
|
@@ -7107,7 +7230,7 @@ type LegalDocument = {
|
|
|
7107
7230
|
/**
|
|
7108
7231
|
* Field included by default.
|
|
7109
7232
|
*/
|
|
7110
|
-
document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc";
|
|
7233
|
+
document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc" | "npp" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form";
|
|
7111
7234
|
/**
|
|
7112
7235
|
* Field included by default.
|
|
7113
7236
|
*/
|
|
@@ -21755,9 +21878,7 @@ declare class GptClient extends BaseClient {
|
|
|
21755
21878
|
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
21756
21879
|
list: (options?: {
|
|
21757
21880
|
page?: number;
|
|
21758
|
-
pageSize
|
|
21759
|
-
/** Training examples and sessions */
|
|
21760
|
-
? /** Training examples and sessions */: number;
|
|
21881
|
+
pageSize?: number;
|
|
21761
21882
|
} & RequestOptions) => Promise<WebhookConfig[]>;
|
|
21762
21883
|
listAll: (options?: RequestOptions) => Promise<WebhookConfig[]>;
|
|
21763
21884
|
create: (attributes: CreateWebhookConfigAttributes, options?: RequestOptions) => Promise<WebhookConfig>;
|
|
@@ -21923,6 +22044,23 @@ declare class GptClient extends BaseClient {
|
|
|
21923
22044
|
listPresets(params?: Record<string, string>): Promise<PermissionPresetListResult>;
|
|
21924
22045
|
getPreset(id: string): Promise<PermissionPresetResult>;
|
|
21925
22046
|
};
|
|
22047
|
+
/** Structured document sections — section documents and document sections */
|
|
22048
|
+
readonly memory: {
|
|
22049
|
+
sectionDocuments: {
|
|
22050
|
+
list: (params?: {
|
|
22051
|
+
page?: number;
|
|
22052
|
+
pageSize?: number;
|
|
22053
|
+
}, options?: RequestOptions) => Promise<SectionDocument[]>;
|
|
22054
|
+
get: (id: string, options?: RequestOptions) => Promise<SectionDocument>;
|
|
22055
|
+
};
|
|
22056
|
+
documentSections: {
|
|
22057
|
+
list: (params?: {
|
|
22058
|
+
page?: number;
|
|
22059
|
+
pageSize?: number;
|
|
22060
|
+
}, options?: RequestOptions) => Promise<DocumentSection[]>;
|
|
22061
|
+
get: (id: string, options?: RequestOptions) => Promise<DocumentSection>;
|
|
22062
|
+
};
|
|
22063
|
+
};
|
|
21926
22064
|
constructor(config?: BaseClientConfig);
|
|
21927
22065
|
/**
|
|
21928
22066
|
* Subscribe to SDK lifecycle events.
|
|
@@ -22053,6 +22191,108 @@ declare class Webhooks {
|
|
|
22053
22191
|
static safeVerify(payload: string, signatureHeader: string, secret: string, options?: WebhookVerifyOptions): Promise<boolean>;
|
|
22054
22192
|
}
|
|
22055
22193
|
|
|
22194
|
+
/**
|
|
22195
|
+
* Creates the memory namespace for structured document section navigation.
|
|
22196
|
+
*
|
|
22197
|
+
* Provides access to indexed document structures and their heading-delimited
|
|
22198
|
+
* sections. Documents are indexed from extraction results, crawler output,
|
|
22199
|
+
* knowledge files, or direct uploads. Sections support full-text search
|
|
22200
|
+
* and byte-range content retrieval.
|
|
22201
|
+
*
|
|
22202
|
+
* Accessed via `client.memory.*`.
|
|
22203
|
+
*
|
|
22204
|
+
* @param rb - The internal `RequestBuilder` instance used to execute API calls.
|
|
22205
|
+
* @returns An object containing `sectionDocuments` and `documentSections`
|
|
22206
|
+
* sub-namespaces.
|
|
22207
|
+
*/
|
|
22208
|
+
declare function createMemoryNamespace(rb: RequestBuilder): {
|
|
22209
|
+
/**
|
|
22210
|
+
* Sub-namespace for section document operations.
|
|
22211
|
+
*
|
|
22212
|
+
* A section document represents an indexed source (extraction document,
|
|
22213
|
+
* crawler page, knowledge file, or direct upload). Each section document
|
|
22214
|
+
* contains metadata about the source and links to its document sections.
|
|
22215
|
+
*/
|
|
22216
|
+
sectionDocuments: {
|
|
22217
|
+
/**
|
|
22218
|
+
* Lists section documents in the current workspace.
|
|
22219
|
+
*
|
|
22220
|
+
* Returns paginated results sorted by creation date (newest first).
|
|
22221
|
+
*
|
|
22222
|
+
* @param params - Optional pagination parameters (`page[offset]`, `page[limit]`).
|
|
22223
|
+
* @param options - Optional request options such as custom headers or abort signal.
|
|
22224
|
+
* @returns A promise resolving to an array of section document records.
|
|
22225
|
+
*
|
|
22226
|
+
* @example
|
|
22227
|
+
* ```typescript
|
|
22228
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
22229
|
+
* const docs = await client.memory.sectionDocuments.list();
|
|
22230
|
+
* docs.forEach(d => console.log(d.attributes?.doc_path));
|
|
22231
|
+
* ```
|
|
22232
|
+
*/
|
|
22233
|
+
list: (params?: {
|
|
22234
|
+
page?: number;
|
|
22235
|
+
pageSize?: number;
|
|
22236
|
+
}, options?: RequestOptions) => Promise<SectionDocument[]>;
|
|
22237
|
+
/**
|
|
22238
|
+
* Retrieves a single section document by its unique identifier.
|
|
22239
|
+
*
|
|
22240
|
+
* @param id - The UUID of the section document.
|
|
22241
|
+
* @param options - Optional request options.
|
|
22242
|
+
* @returns A promise resolving to the section document record.
|
|
22243
|
+
*
|
|
22244
|
+
* @example
|
|
22245
|
+
* ```typescript
|
|
22246
|
+
* const doc = await client.memory.sectionDocuments.get('sd_01HXYZ...');
|
|
22247
|
+
* console.log(doc.attributes?.source_type, doc.attributes?.section_count);
|
|
22248
|
+
* ```
|
|
22249
|
+
*/
|
|
22250
|
+
get: (id: string, options?: RequestOptions) => Promise<SectionDocument>;
|
|
22251
|
+
};
|
|
22252
|
+
/**
|
|
22253
|
+
* Sub-namespace for document section operations.
|
|
22254
|
+
*
|
|
22255
|
+
* A document section represents one heading-delimited portion of an
|
|
22256
|
+
* indexed document. Sections have stable IDs that survive re-indexing,
|
|
22257
|
+
* enabling persistent cross-document references.
|
|
22258
|
+
*/
|
|
22259
|
+
documentSections: {
|
|
22260
|
+
/**
|
|
22261
|
+
* Lists document sections in the current workspace.
|
|
22262
|
+
*
|
|
22263
|
+
* Returns paginated results sorted by position within their documents.
|
|
22264
|
+
*
|
|
22265
|
+
* @param params - Optional pagination parameters.
|
|
22266
|
+
* @param options - Optional request options.
|
|
22267
|
+
* @returns A promise resolving to an array of document section records.
|
|
22268
|
+
*
|
|
22269
|
+
* @example
|
|
22270
|
+
* ```typescript
|
|
22271
|
+
* const sections = await client.memory.documentSections.list();
|
|
22272
|
+
* sections.forEach(s => console.log(s.attributes?.title, s.attributes?.level));
|
|
22273
|
+
* ```
|
|
22274
|
+
*/
|
|
22275
|
+
list: (params?: {
|
|
22276
|
+
page?: number;
|
|
22277
|
+
pageSize?: number;
|
|
22278
|
+
}, options?: RequestOptions) => Promise<DocumentSection[]>;
|
|
22279
|
+
/**
|
|
22280
|
+
* Retrieves a single document section by its unique identifier.
|
|
22281
|
+
*
|
|
22282
|
+
* @param id - The UUID of the document section.
|
|
22283
|
+
* @param options - Optional request options.
|
|
22284
|
+
* @returns A promise resolving to the document section record.
|
|
22285
|
+
*
|
|
22286
|
+
* @example
|
|
22287
|
+
* ```typescript
|
|
22288
|
+
* const section = await client.memory.documentSections.get('ds_01HXYZ...');
|
|
22289
|
+
* console.log(section.attributes?.title, section.attributes?.content_preview);
|
|
22290
|
+
* ```
|
|
22291
|
+
*/
|
|
22292
|
+
get: (id: string, options?: RequestOptions) => Promise<DocumentSection>;
|
|
22293
|
+
};
|
|
22294
|
+
};
|
|
22295
|
+
|
|
22056
22296
|
type ThreadsAPI = ReturnType<typeof createThreadsNamespace>;
|
|
22057
22297
|
type SearchAPI = ReturnType<typeof createSearchNamespace>;
|
|
22058
22298
|
type IdentityAPI = ReturnType<typeof createIdentityNamespace>;
|
|
@@ -22069,5 +22309,6 @@ type WebhooksAPI = ReturnType<typeof createWebhooksNamespace>;
|
|
|
22069
22309
|
type SchedulingAPI = ReturnType<typeof createSchedulingNamespace>;
|
|
22070
22310
|
type VoiceAPI = ReturnType<typeof createVoiceNamespace>;
|
|
22071
22311
|
type ModelsAPI = ReturnType<typeof createModelsNamespace>;
|
|
22312
|
+
type MemoryAPI = ReturnType<typeof createMemoryNamespace>;
|
|
22072
22313
|
|
|
22073
|
-
export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, CardDeclinedError, type CommunicationAPI, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type LogLevel, type Logger, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type WebhooksAPI, type Workspace, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };
|
|
22314
|
+
export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, CardDeclinedError, type CommunicationAPI, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DocumentSection, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type LogLevel, type Logger, type MemoryAPI, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SectionDocument, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type WebhooksAPI, type Workspace, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };
|
package/dist/index.d.ts
CHANGED
|
@@ -606,7 +606,7 @@ declare class BrowserApiKeyError extends Error {
|
|
|
606
606
|
}
|
|
607
607
|
|
|
608
608
|
/** SDK version — updated automatically by mix update.sdks */
|
|
609
|
-
declare const SDK_VERSION = "0.7.
|
|
609
|
+
declare const SDK_VERSION = "0.7.1";
|
|
610
610
|
/** Default API version sent in every request — updated automatically by mix update.sdks */
|
|
611
611
|
declare const DEFAULT_API_VERSION = "2026-03-11";
|
|
612
612
|
|
|
@@ -3232,7 +3232,26 @@ type ProcessingActivity = {
|
|
|
3232
3232
|
* An attributes object for a processing_activity
|
|
3233
3233
|
*/
|
|
3234
3234
|
attributes?: {
|
|
3235
|
-
|
|
3235
|
+
/**
|
|
3236
|
+
* EphiAsset IDs linked to this processing activity. Field included by default.
|
|
3237
|
+
*/
|
|
3238
|
+
asset_ids?: Array<string> | null | unknown;
|
|
3239
|
+
/**
|
|
3240
|
+
* Whether this processing activity involves ePHI. Field included by default.
|
|
3241
|
+
*/
|
|
3242
|
+
ephi_classification?: "contains_ephi" | "no_ephi" | unknown;
|
|
3243
|
+
/**
|
|
3244
|
+
* Last review date for this processing activity. Field included by default.
|
|
3245
|
+
*/
|
|
3246
|
+
last_reviewed_at?: string | null | unknown;
|
|
3247
|
+
/**
|
|
3248
|
+
* HIPAA minimum necessary standard justification. Field included by default.
|
|
3249
|
+
*/
|
|
3250
|
+
minimum_necessary_justification?: string | null | unknown;
|
|
3251
|
+
/**
|
|
3252
|
+
* How often this activity should be reviewed (days). Field included by default.
|
|
3253
|
+
*/
|
|
3254
|
+
review_frequency_days?: number | null | unknown;
|
|
3236
3255
|
};
|
|
3237
3256
|
id: string;
|
|
3238
3257
|
/**
|
|
@@ -4525,6 +4544,52 @@ type WatcherClaim = {
|
|
|
4525
4544
|
};
|
|
4526
4545
|
type: string;
|
|
4527
4546
|
};
|
|
4547
|
+
/**
|
|
4548
|
+
* A "Resource object" representing a section-document
|
|
4549
|
+
*/
|
|
4550
|
+
type SectionDocument = {
|
|
4551
|
+
/**
|
|
4552
|
+
* An attributes object for a section-document
|
|
4553
|
+
*/
|
|
4554
|
+
attributes?: {
|
|
4555
|
+
/**
|
|
4556
|
+
* Field included by default.
|
|
4557
|
+
*/
|
|
4558
|
+
doc_path?: string | null | unknown;
|
|
4559
|
+
/**
|
|
4560
|
+
* Field included by default.
|
|
4561
|
+
*/
|
|
4562
|
+
format?: "markdown" | "mdx" | "html" | "text" | "rst" | unknown;
|
|
4563
|
+
/**
|
|
4564
|
+
* Field included by default.
|
|
4565
|
+
*/
|
|
4566
|
+
indexed_at?: unknown;
|
|
4567
|
+
/**
|
|
4568
|
+
* Field included by default.
|
|
4569
|
+
*/
|
|
4570
|
+
section_count?: number | null | unknown;
|
|
4571
|
+
/**
|
|
4572
|
+
* Field included by default.
|
|
4573
|
+
*/
|
|
4574
|
+
source_id?: string | null | unknown;
|
|
4575
|
+
/**
|
|
4576
|
+
* Field included by default.
|
|
4577
|
+
*/
|
|
4578
|
+
source_type: "extraction" | "crawler" | "knowledge_file" | "direct";
|
|
4579
|
+
/**
|
|
4580
|
+
* Field included by default.
|
|
4581
|
+
*/
|
|
4582
|
+
source_url?: string | null | unknown;
|
|
4583
|
+
};
|
|
4584
|
+
id: string;
|
|
4585
|
+
/**
|
|
4586
|
+
* A relationships object for a section-document
|
|
4587
|
+
*/
|
|
4588
|
+
relationships?: {
|
|
4589
|
+
[key: string]: never;
|
|
4590
|
+
};
|
|
4591
|
+
type: string;
|
|
4592
|
+
};
|
|
4528
4593
|
/**
|
|
4529
4594
|
* A "Resource object" representing a tenant
|
|
4530
4595
|
*/
|
|
@@ -6026,6 +6091,64 @@ type PermissionMeta = {
|
|
|
6026
6091
|
};
|
|
6027
6092
|
type: string;
|
|
6028
6093
|
};
|
|
6094
|
+
/**
|
|
6095
|
+
* A "Resource object" representing a document-section
|
|
6096
|
+
*/
|
|
6097
|
+
type DocumentSection = {
|
|
6098
|
+
/**
|
|
6099
|
+
* An attributes object for a document-section
|
|
6100
|
+
*/
|
|
6101
|
+
attributes?: {
|
|
6102
|
+
/**
|
|
6103
|
+
* Field included by default.
|
|
6104
|
+
*/
|
|
6105
|
+
content_preview?: string | null | unknown;
|
|
6106
|
+
/**
|
|
6107
|
+
* Field included by default.
|
|
6108
|
+
*/
|
|
6109
|
+
doc_path: string;
|
|
6110
|
+
/**
|
|
6111
|
+
* Field included by default.
|
|
6112
|
+
*/
|
|
6113
|
+
level: number;
|
|
6114
|
+
/**
|
|
6115
|
+
* Field included by default.
|
|
6116
|
+
*/
|
|
6117
|
+
parent_stable_id?: string | null | unknown;
|
|
6118
|
+
/**
|
|
6119
|
+
* Field included by default.
|
|
6120
|
+
*/
|
|
6121
|
+
position?: number | null | unknown;
|
|
6122
|
+
/**
|
|
6123
|
+
* Field included by default.
|
|
6124
|
+
*/
|
|
6125
|
+
references?: Array<string> | null | unknown;
|
|
6126
|
+
/**
|
|
6127
|
+
* Field included by default.
|
|
6128
|
+
*/
|
|
6129
|
+
stable_id: string;
|
|
6130
|
+
/**
|
|
6131
|
+
* Field included by default.
|
|
6132
|
+
*/
|
|
6133
|
+
summary?: string | null | unknown;
|
|
6134
|
+
/**
|
|
6135
|
+
* Field included by default.
|
|
6136
|
+
*/
|
|
6137
|
+
tags?: Array<string> | null | unknown;
|
|
6138
|
+
/**
|
|
6139
|
+
* Field included by default.
|
|
6140
|
+
*/
|
|
6141
|
+
title: string;
|
|
6142
|
+
};
|
|
6143
|
+
id: string;
|
|
6144
|
+
/**
|
|
6145
|
+
* A relationships object for a document-section
|
|
6146
|
+
*/
|
|
6147
|
+
relationships?: {
|
|
6148
|
+
[key: string]: never;
|
|
6149
|
+
};
|
|
6150
|
+
type: string;
|
|
6151
|
+
};
|
|
6029
6152
|
/**
|
|
6030
6153
|
* A "Resource object" representing a clinical-delivery
|
|
6031
6154
|
*/
|
|
@@ -7107,7 +7230,7 @@ type LegalDocument = {
|
|
|
7107
7230
|
/**
|
|
7108
7231
|
* Field included by default.
|
|
7109
7232
|
*/
|
|
7110
|
-
document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc";
|
|
7233
|
+
document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc" | "npp" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form";
|
|
7111
7234
|
/**
|
|
7112
7235
|
* Field included by default.
|
|
7113
7236
|
*/
|
|
@@ -21755,9 +21878,7 @@ declare class GptClient extends BaseClient {
|
|
|
21755
21878
|
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
21756
21879
|
list: (options?: {
|
|
21757
21880
|
page?: number;
|
|
21758
|
-
pageSize
|
|
21759
|
-
/** Training examples and sessions */
|
|
21760
|
-
? /** Training examples and sessions */: number;
|
|
21881
|
+
pageSize?: number;
|
|
21761
21882
|
} & RequestOptions) => Promise<WebhookConfig[]>;
|
|
21762
21883
|
listAll: (options?: RequestOptions) => Promise<WebhookConfig[]>;
|
|
21763
21884
|
create: (attributes: CreateWebhookConfigAttributes, options?: RequestOptions) => Promise<WebhookConfig>;
|
|
@@ -21923,6 +22044,23 @@ declare class GptClient extends BaseClient {
|
|
|
21923
22044
|
listPresets(params?: Record<string, string>): Promise<PermissionPresetListResult>;
|
|
21924
22045
|
getPreset(id: string): Promise<PermissionPresetResult>;
|
|
21925
22046
|
};
|
|
22047
|
+
/** Structured document sections — section documents and document sections */
|
|
22048
|
+
readonly memory: {
|
|
22049
|
+
sectionDocuments: {
|
|
22050
|
+
list: (params?: {
|
|
22051
|
+
page?: number;
|
|
22052
|
+
pageSize?: number;
|
|
22053
|
+
}, options?: RequestOptions) => Promise<SectionDocument[]>;
|
|
22054
|
+
get: (id: string, options?: RequestOptions) => Promise<SectionDocument>;
|
|
22055
|
+
};
|
|
22056
|
+
documentSections: {
|
|
22057
|
+
list: (params?: {
|
|
22058
|
+
page?: number;
|
|
22059
|
+
pageSize?: number;
|
|
22060
|
+
}, options?: RequestOptions) => Promise<DocumentSection[]>;
|
|
22061
|
+
get: (id: string, options?: RequestOptions) => Promise<DocumentSection>;
|
|
22062
|
+
};
|
|
22063
|
+
};
|
|
21926
22064
|
constructor(config?: BaseClientConfig);
|
|
21927
22065
|
/**
|
|
21928
22066
|
* Subscribe to SDK lifecycle events.
|
|
@@ -22053,6 +22191,108 @@ declare class Webhooks {
|
|
|
22053
22191
|
static safeVerify(payload: string, signatureHeader: string, secret: string, options?: WebhookVerifyOptions): Promise<boolean>;
|
|
22054
22192
|
}
|
|
22055
22193
|
|
|
22194
|
+
/**
|
|
22195
|
+
* Creates the memory namespace for structured document section navigation.
|
|
22196
|
+
*
|
|
22197
|
+
* Provides access to indexed document structures and their heading-delimited
|
|
22198
|
+
* sections. Documents are indexed from extraction results, crawler output,
|
|
22199
|
+
* knowledge files, or direct uploads. Sections support full-text search
|
|
22200
|
+
* and byte-range content retrieval.
|
|
22201
|
+
*
|
|
22202
|
+
* Accessed via `client.memory.*`.
|
|
22203
|
+
*
|
|
22204
|
+
* @param rb - The internal `RequestBuilder` instance used to execute API calls.
|
|
22205
|
+
* @returns An object containing `sectionDocuments` and `documentSections`
|
|
22206
|
+
* sub-namespaces.
|
|
22207
|
+
*/
|
|
22208
|
+
declare function createMemoryNamespace(rb: RequestBuilder): {
|
|
22209
|
+
/**
|
|
22210
|
+
* Sub-namespace for section document operations.
|
|
22211
|
+
*
|
|
22212
|
+
* A section document represents an indexed source (extraction document,
|
|
22213
|
+
* crawler page, knowledge file, or direct upload). Each section document
|
|
22214
|
+
* contains metadata about the source and links to its document sections.
|
|
22215
|
+
*/
|
|
22216
|
+
sectionDocuments: {
|
|
22217
|
+
/**
|
|
22218
|
+
* Lists section documents in the current workspace.
|
|
22219
|
+
*
|
|
22220
|
+
* Returns paginated results sorted by creation date (newest first).
|
|
22221
|
+
*
|
|
22222
|
+
* @param params - Optional pagination parameters (`page[offset]`, `page[limit]`).
|
|
22223
|
+
* @param options - Optional request options such as custom headers or abort signal.
|
|
22224
|
+
* @returns A promise resolving to an array of section document records.
|
|
22225
|
+
*
|
|
22226
|
+
* @example
|
|
22227
|
+
* ```typescript
|
|
22228
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
22229
|
+
* const docs = await client.memory.sectionDocuments.list();
|
|
22230
|
+
* docs.forEach(d => console.log(d.attributes?.doc_path));
|
|
22231
|
+
* ```
|
|
22232
|
+
*/
|
|
22233
|
+
list: (params?: {
|
|
22234
|
+
page?: number;
|
|
22235
|
+
pageSize?: number;
|
|
22236
|
+
}, options?: RequestOptions) => Promise<SectionDocument[]>;
|
|
22237
|
+
/**
|
|
22238
|
+
* Retrieves a single section document by its unique identifier.
|
|
22239
|
+
*
|
|
22240
|
+
* @param id - The UUID of the section document.
|
|
22241
|
+
* @param options - Optional request options.
|
|
22242
|
+
* @returns A promise resolving to the section document record.
|
|
22243
|
+
*
|
|
22244
|
+
* @example
|
|
22245
|
+
* ```typescript
|
|
22246
|
+
* const doc = await client.memory.sectionDocuments.get('sd_01HXYZ...');
|
|
22247
|
+
* console.log(doc.attributes?.source_type, doc.attributes?.section_count);
|
|
22248
|
+
* ```
|
|
22249
|
+
*/
|
|
22250
|
+
get: (id: string, options?: RequestOptions) => Promise<SectionDocument>;
|
|
22251
|
+
};
|
|
22252
|
+
/**
|
|
22253
|
+
* Sub-namespace for document section operations.
|
|
22254
|
+
*
|
|
22255
|
+
* A document section represents one heading-delimited portion of an
|
|
22256
|
+
* indexed document. Sections have stable IDs that survive re-indexing,
|
|
22257
|
+
* enabling persistent cross-document references.
|
|
22258
|
+
*/
|
|
22259
|
+
documentSections: {
|
|
22260
|
+
/**
|
|
22261
|
+
* Lists document sections in the current workspace.
|
|
22262
|
+
*
|
|
22263
|
+
* Returns paginated results sorted by position within their documents.
|
|
22264
|
+
*
|
|
22265
|
+
* @param params - Optional pagination parameters.
|
|
22266
|
+
* @param options - Optional request options.
|
|
22267
|
+
* @returns A promise resolving to an array of document section records.
|
|
22268
|
+
*
|
|
22269
|
+
* @example
|
|
22270
|
+
* ```typescript
|
|
22271
|
+
* const sections = await client.memory.documentSections.list();
|
|
22272
|
+
* sections.forEach(s => console.log(s.attributes?.title, s.attributes?.level));
|
|
22273
|
+
* ```
|
|
22274
|
+
*/
|
|
22275
|
+
list: (params?: {
|
|
22276
|
+
page?: number;
|
|
22277
|
+
pageSize?: number;
|
|
22278
|
+
}, options?: RequestOptions) => Promise<DocumentSection[]>;
|
|
22279
|
+
/**
|
|
22280
|
+
* Retrieves a single document section by its unique identifier.
|
|
22281
|
+
*
|
|
22282
|
+
* @param id - The UUID of the document section.
|
|
22283
|
+
* @param options - Optional request options.
|
|
22284
|
+
* @returns A promise resolving to the document section record.
|
|
22285
|
+
*
|
|
22286
|
+
* @example
|
|
22287
|
+
* ```typescript
|
|
22288
|
+
* const section = await client.memory.documentSections.get('ds_01HXYZ...');
|
|
22289
|
+
* console.log(section.attributes?.title, section.attributes?.content_preview);
|
|
22290
|
+
* ```
|
|
22291
|
+
*/
|
|
22292
|
+
get: (id: string, options?: RequestOptions) => Promise<DocumentSection>;
|
|
22293
|
+
};
|
|
22294
|
+
};
|
|
22295
|
+
|
|
22056
22296
|
type ThreadsAPI = ReturnType<typeof createThreadsNamespace>;
|
|
22057
22297
|
type SearchAPI = ReturnType<typeof createSearchNamespace>;
|
|
22058
22298
|
type IdentityAPI = ReturnType<typeof createIdentityNamespace>;
|
|
@@ -22069,5 +22309,6 @@ type WebhooksAPI = ReturnType<typeof createWebhooksNamespace>;
|
|
|
22069
22309
|
type SchedulingAPI = ReturnType<typeof createSchedulingNamespace>;
|
|
22070
22310
|
type VoiceAPI = ReturnType<typeof createVoiceNamespace>;
|
|
22071
22311
|
type ModelsAPI = ReturnType<typeof createModelsNamespace>;
|
|
22312
|
+
type MemoryAPI = ReturnType<typeof createMemoryNamespace>;
|
|
22072
22313
|
|
|
22073
|
-
export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, CardDeclinedError, type CommunicationAPI, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type LogLevel, type Logger, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type WebhooksAPI, type Workspace, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };
|
|
22314
|
+
export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, CardDeclinedError, type CommunicationAPI, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DocumentSection, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type LogLevel, type Logger, type MemoryAPI, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SectionDocument, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type WebhooksAPI, type Workspace, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };
|