@lumavox/server 0.13.0 → 0.14.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/README.md +1 -1
- package/dist/client.d.ts +10 -2
- package/dist/client.js +4 -0
- package/dist/gen/index.d.ts +1 -1
- package/dist/gen/types.gen.d.ts +75 -33
- package/dist/resources/agents.d.ts +1 -1
- package/dist/resources/tools.d.ts +4 -2
- package/dist/resources/tools.js +4 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -72,7 +72,7 @@ list's page.
|
|
|
72
72
|
| `tools` | `list`, `page`, `get`, `create` (a webhook's signing secret, shown once), `update`, `delete`, `rotateSecret`, `test` |
|
|
73
73
|
| `knowledge` | `list`, `page`, `get`, `create`, `bulk`, `fromUrl`, `uploadUrl`, `fromFile`, `upload`, `update`, `delete`, `reindex`, `refresh`, `setAgents`, `search`, `categories`, `insights`, `wait` |
|
|
74
74
|
| `usage` | `get`, `plan` |
|
|
75
|
-
| the client | `health()` |
|
|
75
|
+
| the client | `health()`, `limits()` (the platform's limits, each by its key) |
|
|
76
76
|
|
|
77
77
|
- **`list()` is an async iterator over every item**, page after page by
|
|
78
78
|
each page's `next_cursor`; `page()` is one page, `{ data, next_cursor }`.
|
package/dist/client.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* `createClient`: one org API key, one base URL, and a resource per area of
|
|
3
3
|
* the API — every operation an API key may call (`test/coverage.test.ts`
|
|
4
|
-
* holds the document to it), and `health()
|
|
4
|
+
* holds the document to it), and the two that need none: `health()` and
|
|
5
|
+
* `limits()`.
|
|
5
6
|
*
|
|
6
7
|
* - **Nothing is read from `process.env`**: Workers has none, and a key
|
|
7
8
|
* that arrives by argument is one the caller can see arrive.
|
|
@@ -11,7 +12,7 @@
|
|
|
11
12
|
* `(url, init) => env.API.fetch(url, init)`.
|
|
12
13
|
* - **It refuses a browser and React Native** (`runtime.ts`).
|
|
13
14
|
*/
|
|
14
|
-
import type { AudioRequest, HealthResponse, ImageRequest, SkyboxRequest, TranscribeAssetRequest, VideoRequest } from "./gen/index.js";
|
|
15
|
+
import type { AudioRequest, HealthResponse, ImageRequest, PlatformLimit, SkyboxRequest, TranscribeAssetRequest, VideoRequest } from "./gen/index.js";
|
|
15
16
|
import { Agents } from "./resources/agents.js";
|
|
16
17
|
import { Assets } from "./resources/assets.js";
|
|
17
18
|
import { EndUsers } from "./resources/end-users.js";
|
|
@@ -57,5 +58,12 @@ export interface Client {
|
|
|
57
58
|
readonly tools: Tools;
|
|
58
59
|
/** Whether the API is up, and its version. Sends no key. */
|
|
59
60
|
health(options?: RequestOptions): Promise<HealthResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* The platform's limits as they stand now — the tools on an agent, the
|
|
63
|
+
* voices, uploads and knowledge an organisation may keep, the ceilings on
|
|
64
|
+
* an ephemeral key — each by the `key` the reference names it by. The
|
|
65
|
+
* platform's staff may change them. Sends no key.
|
|
66
|
+
*/
|
|
67
|
+
limits(options?: RequestOptions): Promise<PlatformLimit[]>;
|
|
60
68
|
}
|
|
61
69
|
export declare function createClient(options: ClientOptions): Client;
|
package/dist/client.js
CHANGED
|
@@ -50,5 +50,9 @@ export function createClient(options) {
|
|
|
50
50
|
health: (request) => transport
|
|
51
51
|
.request({ method: "GET", path: "/health", open: true }, request)
|
|
52
52
|
.then((answer) => answer.data),
|
|
53
|
+
// One page, always: its `next_cursor` is null.
|
|
54
|
+
limits: (request) => transport
|
|
55
|
+
.request({ method: "GET", path: "/v1/platform/limits", open: true }, request)
|
|
56
|
+
.then((answer) => answer.data.data),
|
|
53
57
|
};
|
|
54
58
|
}
|
package/dist/gen/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export type { AgentCreateRequest, AgentInfo, AgentKnowledgeUpdate, AgentPage, AgentSettingsInfo, AgentSettingsUpdate, AgentStt, AgentSttInfo, AgentSummary, AgentToolsUpdate, AgentUpdate, AgentVoice, AgentVoiceInfo, ApiKeySelf, AssetBulkRequest, AssetDetail, AssetMoveRequest, AssetPage, AssetsAffected, AssetSummary, AssetUpdate, AssignedAgent, AudioRequest, BulkEditKnowledgeData, BulkEditKnowledgeError, BulkEditKnowledgeErrors, BulkEditKnowledgeResponse, BulkEditKnowledgeResponses, ClientOptions, CompactionInfo, CompactRequest, CompactSessionData, CompactSessionError, CompactSessionErrors, CompactSessionResponse, CompactSessionResponses, ConfirmAssetUploadData, ConfirmAssetUploadError, ConfirmAssetUploadErrors, ConfirmAssetUploadResponse, ConfirmAssetUploadResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateAssetFolderData, CreateAssetFolderError, CreateAssetFolderErrors, CreateAssetFolderResponse, CreateAssetFolderResponses, CreateAssetUploadUrlData, CreateAssetUploadUrlError, CreateAssetUploadUrlErrors, CreateAssetUploadUrlResponse, CreateAssetUploadUrlResponses, CreateAudioData, CreateAudioError, CreateAudioErrors, CreateAudioResponse, CreateAudioResponses, CreateEndUserData, CreateEndUserError, CreateEndUserErrors, CreateEndUserFactData, CreateEndUserFactError, CreateEndUserFactErrors, CreateEndUserFactResponse, CreateEndUserFactResponses, CreateEndUserResponse, CreateEndUserResponses, CreateEphemeralKeyData, CreateEphemeralKeyError, CreateEphemeralKeyErrors, CreateEphemeralKeyResponse, CreateEphemeralKeyResponses, CreateFactData, CreateFactError, CreateFactErrors, CreateFactResponse, CreateFactResponses, CreateImageData, CreateImageError, CreateImageErrors, CreateImageResponse, CreateImageResponses, CreateKnowledgeData, CreateKnowledgeError, CreateKnowledgeErrors, CreateKnowledgeFromFileData, CreateKnowledgeFromFileError, CreateKnowledgeFromFileErrors, CreateKnowledgeFromFileResponse, CreateKnowledgeFromFileResponses, CreateKnowledgeFromUrlData, CreateKnowledgeFromUrlError, CreateKnowledgeFromUrlErrors, CreateKnowledgeFromUrlResponse, CreateKnowledgeFromUrlResponses, CreateKnowledgeResponse, CreateKnowledgeResponses, CreateKnowledgeUploadUrlData, CreateKnowledgeUploadUrlError, CreateKnowledgeUploadUrlErrors, CreateKnowledgeUploadUrlResponse, CreateKnowledgeUploadUrlResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionResponse, CreateSessionResponses, CreateSkyboxData, CreateSkyboxError, CreateSkyboxErrors, CreateSkyboxResponse, CreateSkyboxResponses, CreateToolData, CreateToolError, CreateToolErrors, CreateToolResponse, CreateToolResponses, CreateTranscriptionData, CreateTranscriptionError, CreateTranscriptionErrors, CreateTranscriptionResponse, CreateTranscriptionResponses, CreateVideoData, CreateVideoError, CreateVideoErrors, CreateVideoResponse, CreateVideoResponses, CreateVoiceData, CreateVoiceError, CreateVoiceErrors, CreateVoiceResponse, CreateVoiceResponses, CreateVoiceUploadUrlData, CreateVoiceUploadUrlError, CreateVoiceUploadUrlErrors, CreateVoiceUploadUrlResponse, CreateVoiceUploadUrlResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAllFactsData, DeleteAllFactsError, DeleteAllFactsErrors, DeleteAllFactsResponse, DeleteAllFactsResponses, DeleteAssetData, DeleteAssetError, DeleteAssetErrors, DeleteAssetFolderData, DeleteAssetFolderError, DeleteAssetFolderErrors, DeleteAssetFolderResponse, DeleteAssetFolderResponses, DeleteAssetResponse, DeleteAssetResponses, DeleteAssetsData, DeleteAssetsError, DeleteAssetsErrors, DeleteAssetsResponse, DeleteAssetsResponses, DeleteEndUserData, DeleteEndUserError, DeleteEndUserErrors, DeleteEndUserFactData, DeleteEndUserFactError, DeleteEndUserFactErrors, DeleteEndUserFactResponse, DeleteEndUserFactResponses, DeleteEndUserResponse, DeleteEndUserResponses, DeleteFactData, DeleteFactError, DeleteFactErrors, DeleteFactResponse, DeleteFactResponses, DeleteKnowledgeData, DeleteKnowledgeError, DeleteKnowledgeErrors, DeleteKnowledgeResponse, DeleteKnowledgeResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteToolData, DeleteToolError, DeleteToolErrors, DeleteToolResponse, DeleteToolResponses, DeleteVoiceData, DeleteVoiceError, DeleteVoiceErrors, DeleteVoiceResponse, DeleteVoiceResponses, DesignVoiceData, DesignVoiceError, DesignVoiceErrors, DesignVoiceResponse, DesignVoiceResponses, EndUserCreateRequest, EndUserDeleted, EndUserInfo, EndUserPage, EndUserUpdateRequest, EphemeralKeyCreateRequest, EphemeralKeyCreateResponse, EphemeralKeyInfo, EphemeralKeyLimits, EphemeralKeyPage, EphemeralTokenSelf, ErrorCode, ErrorInfo, ErrorResponse, ExtractSessionFactsData, ExtractSessionFactsError, ExtractSessionFactsErrors, ExtractSessionFactsResponse, ExtractSessionFactsResponses, FactCreateRequest, FactInfo, FactPage, FactsDeleted, FactUpdateRequest, FolderCreate, FolderDeleted, FolderDetail, FolderPage, FolderSummary, FolderUpdate, GenerateFromTemplateData, GenerateFromTemplateError, GenerateFromTemplateErrors, GenerateFromTemplateResponse, GenerateFromTemplateResponses, GenerationAudio, GenerationImage, GenerationInfo, GenerationPage, GenerationSkybox, GenerationTranscript, GenerationVideo, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentSettingsData, GetAgentSettingsError, GetAgentSettingsErrors, GetAgentSettingsResponse, GetAgentSettingsResponses, GetAssetData, GetAssetError, GetAssetErrors, GetAssetFolderData, GetAssetFolderError, GetAssetFolderErrors, GetAssetFolderResponse, GetAssetFolderResponses, GetAssetResponse, GetAssetResponses, GetAudioData, GetAudioError, GetAudioErrors, GetAudioResponse, GetAudioResponses, GetEndUserData, GetEndUserError, GetEndUserErrors, GetEndUserResponse, GetEndUserResponses, GetEphemeralKeyData, GetEphemeralKeyError, GetEphemeralKeyErrors, GetEphemeralKeyLimitsData, GetEphemeralKeyLimitsError, GetEphemeralKeyLimitsErrors, GetEphemeralKeyLimitsResponse, GetEphemeralKeyLimitsResponses, GetEphemeralKeyResponse, GetEphemeralKeyResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetHealthData, GetHealthResponse, GetHealthResponses, GetImageData, GetImageError, GetImageErrors, GetImageResponse, GetImageResponses, GetKnowledgeData, GetKnowledgeError, GetKnowledgeErrors, GetKnowledgeInsightsData, GetKnowledgeInsightsError, GetKnowledgeInsightsErrors, GetKnowledgeInsightsResponse, GetKnowledgeInsightsResponses, GetKnowledgeResponse, GetKnowledgeResponses, GetPlanData, GetPlanError, GetPlanErrors, GetPlanResponse, GetPlanResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSkyboxData, GetSkyboxError, GetSkyboxErrors, GetSkyboxResponse, GetSkyboxResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateFileData, GetTemplateFileError, GetTemplateFileErrors, GetTemplateFileResponses, GetTemplateResponse, GetTemplateResponses, GetTokenData, GetTokenError, GetTokenErrors, GetTokenResponse, GetTokenResponses, GetToolData, GetToolError, GetToolErrors, GetToolResponse, GetToolResponses, GetTranscriptionData, GetTranscriptionError, GetTranscriptionErrors, GetTranscriptionResponse, GetTranscriptionResponses, GetUsageData, GetUsageError, GetUsageErrors, GetUsageResponse, GetUsageResponses, GetVideoData, GetVideoError, GetVideoErrors, GetVideoResponse, GetVideoResponses, GetVoiceData, GetVoiceError, GetVoiceErrors, GetVoiceResponse, GetVoiceResponses, HealthResponse, ImageRequest, KnowledgeAgentsUpdate, KnowledgeAssigned, KnowledgeBulk, KnowledgeBulkResult, KnowledgeCategoryPage, KnowledgeCitation, KnowledgeCreate, KnowledgeEntryUsage, KnowledgeFileCreate, KnowledgeInfo, KnowledgeInsights, KnowledgeLookupInfo, KnowledgePage, KnowledgeSearchHit, KnowledgeSearchRequest, KnowledgeSearchResult, KnowledgeUpdate, KnowledgeUploadRequest, KnowledgeUploadTicket, KnowledgeUrlCreate, ListAgentKnowledgeData, ListAgentKnowledgeError, ListAgentKnowledgeErrors, ListAgentKnowledgeResponse, ListAgentKnowledgeResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAgentToolsData, ListAgentToolsError, ListAgentToolsErrors, ListAgentToolsResponse, ListAgentToolsResponses, ListAssetFoldersData, ListAssetFoldersError, ListAssetFoldersErrors, ListAssetFoldersResponse, ListAssetFoldersResponses, ListAssetsData, ListAssetsError, ListAssetsErrors, ListAssetsResponse, ListAssetsResponses, ListEndUserFactsData, ListEndUserFactsError, ListEndUserFactsErrors, ListEndUserFactsResponse, ListEndUserFactsResponses, ListEndUsersData, ListEndUsersError, ListEndUsersErrors, ListEndUsersResponse, ListEndUsersResponses, ListEphemeralKeysData, ListEphemeralKeysError, ListEphemeralKeysErrors, ListEphemeralKeysResponse, ListEphemeralKeysResponses, ListFactsData, ListFactsError, ListFactsErrors, ListFactsResponse, ListFactsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListKnowledgeCategoriesData, ListKnowledgeCategoriesError, ListKnowledgeCategoriesErrors, ListKnowledgeCategoriesResponse, ListKnowledgeCategoriesResponses, ListKnowledgeData, ListKnowledgeError, ListKnowledgeErrors, ListKnowledgeResponse, ListKnowledgeResponses, ListRelationsData, ListRelationsError, ListRelationsErrors, ListRelationsResponse, ListRelationsResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListSkyboxStylesData, ListSkyboxStylesError, ListSkyboxStylesErrors, ListSkyboxStylesResponse, ListSkyboxStylesResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListToolCallsData, ListToolCallsError, ListToolCallsErrors, ListToolCallsResponse, ListToolCallsResponses, ListToolsData, ListToolsError, ListToolsErrors, ListToolsResponse, ListToolsResponses, ListVoicesData, ListVoicesError, ListVoicesErrors, ListVoicesResponse, ListVoicesResponses, MessageInfo, MessageKnowledge, MessagePage, MessageSource, MessageToolCall, MoveAssetsData, MoveAssetsError, MoveAssetsErrors, MoveAssetsResponse, MoveAssetsResponses, OrgPlan, ProviderVoiceSettings, ProviderVoiceSettingsInfo, Reference, RefreshKnowledgeData, RefreshKnowledgeError, RefreshKnowledgeErrors, RefreshKnowledgeResponse, RefreshKnowledgeResponses, ReindexKnowledgeData, ReindexKnowledgeError, ReindexKnowledgeErrors, ReindexKnowledgeResponse, ReindexKnowledgeResponses, RelationInfo, RelationPage, ResampleVoiceData, ResampleVoiceError, ResampleVoiceErrors, ResampleVoiceResponse, ResampleVoiceResponses, RevokeEphemeralKeyData, RevokeEphemeralKeyError, RevokeEphemeralKeyErrors, RevokeEphemeralKeyResponse, RevokeEphemeralKeyResponses, RotateToolSecretData, RotateToolSecretError, RotateToolSecretErrors, RotateToolSecretResponse, RotateToolSecretResponses, SaveDesignedVoiceData, SaveDesignedVoiceError, SaveDesignedVoiceErrors, SaveDesignedVoiceResponse, SaveDesignedVoiceResponses, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SessionCreateRequest, SessionDetail, SessionInfo, SessionPage, SetAgentKnowledgeData, SetAgentKnowledgeError, SetAgentKnowledgeErrors, SetAgentKnowledgeResponse, SetAgentKnowledgeResponses, SetAgentToolsData, SetAgentToolsError, SetAgentToolsErrors, SetAgentToolsResponse, SetAgentToolsResponses, SetKnowledgeAgentsData, SetKnowledgeAgentsError, SetKnowledgeAgentsErrors, SetKnowledgeAgentsResponse, SetKnowledgeAgentsResponses, SkyboxFile, SkyboxRequest, SkyboxStyle, SkyboxStylePage, SpeechProvider, StreamDone, StreamError, StreamSegment, StreamTranscript, SynthesizeSpeechData, SynthesizeSpeechError, SynthesizeSpeechErrors, SynthesizeSpeechResponse, SynthesizeSpeechResponses, TemplateGenerateRequest, TemplateInfo, TemplateInput, TemplatePage, TestToolData, TestToolError, TestToolErrors, TestToolResponse, TestToolResponses, TokenSelf, ToolCall, ToolCallPage, ToolCreate, ToolInfo, ToolPage, ToolsAssigned, ToolTestRequest, ToolTestResult, ToolUpdate, ToolWithSecret, TranscribeAssetRequest, TranscribeData, TranscribeError, TranscribeErrors, TranscribeResponse, TranscribeResponses, Transcription, TranscriptionStreamLine, TranscriptWord, TtsOptions, TtsRequest, UnansweredQuestion, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateAgentSettingsData, UpdateAgentSettingsError, UpdateAgentSettingsErrors, UpdateAgentSettingsResponse, UpdateAgentSettingsResponses, UpdateAssetData, UpdateAssetError, UpdateAssetErrors, UpdateAssetFolderData, UpdateAssetFolderError, UpdateAssetFolderErrors, UpdateAssetFolderResponse, UpdateAssetFolderResponses, UpdateAssetResponse, UpdateAssetResponses, UpdateEndUserData, UpdateEndUserError, UpdateEndUserErrors, UpdateEndUserFactData, UpdateEndUserFactError, UpdateEndUserFactErrors, UpdateEndUserFactResponse, UpdateEndUserFactResponses, UpdateEndUserResponse, UpdateEndUserResponses, UpdateFactData, UpdateFactError, UpdateFactErrors, UpdateFactResponse, UpdateFactResponses, UpdateKnowledgeData, UpdateKnowledgeError, UpdateKnowledgeErrors, UpdateKnowledgeResponse, UpdateKnowledgeResponses, UpdateToolData, UpdateToolError, UpdateToolErrors, UpdateToolResponse, UpdateToolResponses, UpdateVoiceData, UpdateVoiceError, UpdateVoiceErrors, UpdateVoiceResponse, UpdateVoiceResponses, UploadConfirm, UploadTicket, UploadTicketRequest, UsageByKey, UsageDay, UsageResponse, UsageSummary, ValidationIssue, VariantInfo, VideoRequest, VoiceDesignPreview, VoiceDesignRequest, VoiceDesignResult, VoiceDesignSaveRequest, VoiceDetail, VoiceInfo, VoiceInfoPage, VoiceKind, VoiceSample, VoiceSource, VoiceStatus, VoiceUpdate, VoiceUpload, VoiceUploadRequest, VoiceUploadTicket } from './types.gen.js';
|
|
1
|
+
export type { AgentCreateRequest, AgentInfo, AgentKnowledgeUpdate, AgentPage, AgentSettingsInfo, AgentSettingsUpdate, AgentStt, AgentSttInfo, AgentSummary, AgentToolsUpdate, AgentUpdate, AgentVoice, AgentVoiceInfo, ApiKeySelf, AssetBulkRequest, AssetDetail, AssetMoveRequest, AssetPage, AssetsAffected, AssetSummary, AssetUpdate, AssignedAgent, AudioRequest, BulkEditKnowledgeData, BulkEditKnowledgeError, BulkEditKnowledgeErrors, BulkEditKnowledgeResponse, BulkEditKnowledgeResponses, ClientOptions, CompactionInfo, CompactRequest, CompactSessionData, CompactSessionError, CompactSessionErrors, CompactSessionResponse, CompactSessionResponses, ConfirmAssetUploadData, ConfirmAssetUploadError, ConfirmAssetUploadErrors, ConfirmAssetUploadResponse, ConfirmAssetUploadResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateAssetFolderData, CreateAssetFolderError, CreateAssetFolderErrors, CreateAssetFolderResponse, CreateAssetFolderResponses, CreateAssetUploadUrlData, CreateAssetUploadUrlError, CreateAssetUploadUrlErrors, CreateAssetUploadUrlResponse, CreateAssetUploadUrlResponses, CreateAudioData, CreateAudioError, CreateAudioErrors, CreateAudioResponse, CreateAudioResponses, CreateEndUserData, CreateEndUserError, CreateEndUserErrors, CreateEndUserFactData, CreateEndUserFactError, CreateEndUserFactErrors, CreateEndUserFactResponse, CreateEndUserFactResponses, CreateEndUserResponse, CreateEndUserResponses, CreateEphemeralKeyData, CreateEphemeralKeyError, CreateEphemeralKeyErrors, CreateEphemeralKeyResponse, CreateEphemeralKeyResponses, CreateFactData, CreateFactError, CreateFactErrors, CreateFactResponse, CreateFactResponses, CreateImageData, CreateImageError, CreateImageErrors, CreateImageResponse, CreateImageResponses, CreateKnowledgeData, CreateKnowledgeError, CreateKnowledgeErrors, CreateKnowledgeFromFileData, CreateKnowledgeFromFileError, CreateKnowledgeFromFileErrors, CreateKnowledgeFromFileResponse, CreateKnowledgeFromFileResponses, CreateKnowledgeFromUrlData, CreateKnowledgeFromUrlError, CreateKnowledgeFromUrlErrors, CreateKnowledgeFromUrlResponse, CreateKnowledgeFromUrlResponses, CreateKnowledgeResponse, CreateKnowledgeResponses, CreateKnowledgeUploadUrlData, CreateKnowledgeUploadUrlError, CreateKnowledgeUploadUrlErrors, CreateKnowledgeUploadUrlResponse, CreateKnowledgeUploadUrlResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionResponse, CreateSessionResponses, CreateSkyboxData, CreateSkyboxError, CreateSkyboxErrors, CreateSkyboxResponse, CreateSkyboxResponses, CreateToolData, CreateToolError, CreateToolErrors, CreateToolResponse, CreateToolResponses, CreateTranscriptionData, CreateTranscriptionError, CreateTranscriptionErrors, CreateTranscriptionResponse, CreateTranscriptionResponses, CreateVideoData, CreateVideoError, CreateVideoErrors, CreateVideoResponse, CreateVideoResponses, CreateVoiceData, CreateVoiceError, CreateVoiceErrors, CreateVoiceResponse, CreateVoiceResponses, CreateVoiceUploadUrlData, CreateVoiceUploadUrlError, CreateVoiceUploadUrlErrors, CreateVoiceUploadUrlResponse, CreateVoiceUploadUrlResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAllFactsData, DeleteAllFactsError, DeleteAllFactsErrors, DeleteAllFactsResponse, DeleteAllFactsResponses, DeleteAssetData, DeleteAssetError, DeleteAssetErrors, DeleteAssetFolderData, DeleteAssetFolderError, DeleteAssetFolderErrors, DeleteAssetFolderResponse, DeleteAssetFolderResponses, DeleteAssetResponse, DeleteAssetResponses, DeleteAssetsData, DeleteAssetsError, DeleteAssetsErrors, DeleteAssetsResponse, DeleteAssetsResponses, DeleteEndUserData, DeleteEndUserError, DeleteEndUserErrors, DeleteEndUserFactData, DeleteEndUserFactError, DeleteEndUserFactErrors, DeleteEndUserFactResponse, DeleteEndUserFactResponses, DeleteEndUserResponse, DeleteEndUserResponses, DeleteFactData, DeleteFactError, DeleteFactErrors, DeleteFactResponse, DeleteFactResponses, DeleteKnowledgeData, DeleteKnowledgeError, DeleteKnowledgeErrors, DeleteKnowledgeResponse, DeleteKnowledgeResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteToolData, DeleteToolError, DeleteToolErrors, DeleteToolResponse, DeleteToolResponses, DeleteVoiceData, DeleteVoiceError, DeleteVoiceErrors, DeleteVoiceResponse, DeleteVoiceResponses, DesignVoiceData, DesignVoiceError, DesignVoiceErrors, DesignVoiceResponse, DesignVoiceResponses, EndUserCreateRequest, EndUserDeleted, EndUserInfo, EndUserPage, EndUserUpdateRequest, EphemeralKeyCreateRequest, EphemeralKeyCreateResponse, EphemeralKeyInfo, EphemeralKeyLimits, EphemeralKeyPage, EphemeralTokenSelf, ErrorCode, ErrorInfo, ErrorResponse, ExtractSessionFactsData, ExtractSessionFactsError, ExtractSessionFactsErrors, ExtractSessionFactsResponse, ExtractSessionFactsResponses, FactCreateRequest, FactInfo, FactPage, FactsDeleted, FactUpdateRequest, FolderCreate, FolderDeleted, FolderDetail, FolderPage, FolderSummary, FolderUpdate, GenerateFromTemplateData, GenerateFromTemplateError, GenerateFromTemplateErrors, GenerateFromTemplateResponse, GenerateFromTemplateResponses, GenerationAudio, GenerationImage, GenerationInfo, GenerationPage, GenerationSkybox, GenerationTranscript, GenerationVideo, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentSettingsData, GetAgentSettingsError, GetAgentSettingsErrors, GetAgentSettingsResponse, GetAgentSettingsResponses, GetAssetData, GetAssetError, GetAssetErrors, GetAssetFolderData, GetAssetFolderError, GetAssetFolderErrors, GetAssetFolderResponse, GetAssetFolderResponses, GetAssetResponse, GetAssetResponses, GetAudioData, GetAudioError, GetAudioErrors, GetAudioResponse, GetAudioResponses, GetEndUserData, GetEndUserError, GetEndUserErrors, GetEndUserResponse, GetEndUserResponses, GetEphemeralKeyData, GetEphemeralKeyError, GetEphemeralKeyErrors, GetEphemeralKeyLimitsData, GetEphemeralKeyLimitsError, GetEphemeralKeyLimitsErrors, GetEphemeralKeyLimitsResponse, GetEphemeralKeyLimitsResponses, GetEphemeralKeyResponse, GetEphemeralKeyResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetHealthData, GetHealthResponse, GetHealthResponses, GetImageData, GetImageError, GetImageErrors, GetImageResponse, GetImageResponses, GetKnowledgeData, GetKnowledgeError, GetKnowledgeErrors, GetKnowledgeInsightsData, GetKnowledgeInsightsError, GetKnowledgeInsightsErrors, GetKnowledgeInsightsResponse, GetKnowledgeInsightsResponses, GetKnowledgeResponse, GetKnowledgeResponses, GetPlanData, GetPlanError, GetPlanErrors, GetPlanResponse, GetPlanResponses, GetPlatformLimitsData, GetPlatformLimitsResponse, GetPlatformLimitsResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSkyboxData, GetSkyboxError, GetSkyboxErrors, GetSkyboxResponse, GetSkyboxResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateFileData, GetTemplateFileError, GetTemplateFileErrors, GetTemplateFileResponses, GetTemplateResponse, GetTemplateResponses, GetTokenData, GetTokenError, GetTokenErrors, GetTokenResponse, GetTokenResponses, GetToolData, GetToolError, GetToolErrors, GetToolResponse, GetToolResponses, GetTranscriptionData, GetTranscriptionError, GetTranscriptionErrors, GetTranscriptionResponse, GetTranscriptionResponses, GetUsageData, GetUsageError, GetUsageErrors, GetUsageResponse, GetUsageResponses, GetVideoData, GetVideoError, GetVideoErrors, GetVideoResponse, GetVideoResponses, GetVoiceData, GetVoiceError, GetVoiceErrors, GetVoiceResponse, GetVoiceResponses, HealthResponse, ImageRequest, KnowledgeAgentsUpdate, KnowledgeAssigned, KnowledgeBulk, KnowledgeBulkResult, KnowledgeCategoryPage, KnowledgeCitation, KnowledgeCreate, KnowledgeEntryUsage, KnowledgeFileCreate, KnowledgeInfo, KnowledgeInsights, KnowledgeLookupInfo, KnowledgePage, KnowledgeSearchHit, KnowledgeSearchRequest, KnowledgeSearchResult, KnowledgeUpdate, KnowledgeUploadRequest, KnowledgeUploadTicket, KnowledgeUrlCreate, ListAgentKnowledgeData, ListAgentKnowledgeError, ListAgentKnowledgeErrors, ListAgentKnowledgeResponse, ListAgentKnowledgeResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAgentToolsData, ListAgentToolsError, ListAgentToolsErrors, ListAgentToolsResponse, ListAgentToolsResponses, ListAssetFoldersData, ListAssetFoldersError, ListAssetFoldersErrors, ListAssetFoldersResponse, ListAssetFoldersResponses, ListAssetsData, ListAssetsError, ListAssetsErrors, ListAssetsResponse, ListAssetsResponses, ListEndUserFactsData, ListEndUserFactsError, ListEndUserFactsErrors, ListEndUserFactsResponse, ListEndUserFactsResponses, ListEndUsersData, ListEndUsersError, ListEndUsersErrors, ListEndUsersResponse, ListEndUsersResponses, ListEphemeralKeysData, ListEphemeralKeysError, ListEphemeralKeysErrors, ListEphemeralKeysResponse, ListEphemeralKeysResponses, ListFactsData, ListFactsError, ListFactsErrors, ListFactsResponse, ListFactsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListKnowledgeCategoriesData, ListKnowledgeCategoriesError, ListKnowledgeCategoriesErrors, ListKnowledgeCategoriesResponse, ListKnowledgeCategoriesResponses, ListKnowledgeData, ListKnowledgeError, ListKnowledgeErrors, ListKnowledgeResponse, ListKnowledgeResponses, ListRelationsData, ListRelationsError, ListRelationsErrors, ListRelationsResponse, ListRelationsResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListSkyboxStylesData, ListSkyboxStylesError, ListSkyboxStylesErrors, ListSkyboxStylesResponse, ListSkyboxStylesResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListToolCallsData, ListToolCallsError, ListToolCallsErrors, ListToolCallsResponse, ListToolCallsResponses, ListToolsData, ListToolsError, ListToolsErrors, ListToolsResponse, ListToolsResponses, ListVoicesData, ListVoicesError, ListVoicesErrors, ListVoicesResponse, ListVoicesResponses, MessageInfo, MessageKnowledge, MessagePage, MessageSource, MessageToolCall, MoveAssetsData, MoveAssetsError, MoveAssetsErrors, MoveAssetsResponse, MoveAssetsResponses, OrgPlan, PlatformLimit, PlatformLimitPage, ProviderVoiceSettings, ProviderVoiceSettingsInfo, Reference, RefreshKnowledgeData, RefreshKnowledgeError, RefreshKnowledgeErrors, RefreshKnowledgeResponse, RefreshKnowledgeResponses, ReindexKnowledgeData, ReindexKnowledgeError, ReindexKnowledgeErrors, ReindexKnowledgeResponse, ReindexKnowledgeResponses, RelationInfo, RelationPage, ResampleVoiceData, ResampleVoiceError, ResampleVoiceErrors, ResampleVoiceResponse, ResampleVoiceResponses, RevokeEphemeralKeyData, RevokeEphemeralKeyError, RevokeEphemeralKeyErrors, RevokeEphemeralKeyResponse, RevokeEphemeralKeyResponses, RotateToolSecretData, RotateToolSecretError, RotateToolSecretErrors, RotateToolSecretResponse, RotateToolSecretResponses, SaveDesignedVoiceData, SaveDesignedVoiceError, SaveDesignedVoiceErrors, SaveDesignedVoiceResponse, SaveDesignedVoiceResponses, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SessionCreateRequest, SessionDetail, SessionInfo, SessionPage, SetAgentKnowledgeData, SetAgentKnowledgeError, SetAgentKnowledgeErrors, SetAgentKnowledgeResponse, SetAgentKnowledgeResponses, SetAgentToolsData, SetAgentToolsError, SetAgentToolsErrors, SetAgentToolsResponse, SetAgentToolsResponses, SetKnowledgeAgentsData, SetKnowledgeAgentsError, SetKnowledgeAgentsErrors, SetKnowledgeAgentsResponse, SetKnowledgeAgentsResponses, SkyboxFile, SkyboxRequest, SkyboxStyle, SkyboxStylePage, SpeechProvider, StreamDone, StreamError, StreamSegment, StreamTranscript, SynthesizeSpeechData, SynthesizeSpeechError, SynthesizeSpeechErrors, SynthesizeSpeechResponse, SynthesizeSpeechResponses, TemplateGenerateRequest, TemplateInfo, TemplateInput, TemplatePage, TestToolData, TestToolError, TestToolErrors, TestToolResponse, TestToolResponses, TokenSelf, ToolCall, ToolCallPage, ToolCreate, ToolInfo, ToolPage, ToolsAssigned, ToolTestRequest, ToolTestResult, ToolUpdate, ToolWithSecret, TranscribeAssetRequest, TranscribeData, TranscribeError, TranscribeErrors, TranscribeResponse, TranscribeResponses, Transcription, TranscriptionStreamLine, TranscriptWord, TtsOptions, TtsRequest, UnansweredQuestion, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateAgentSettingsData, UpdateAgentSettingsError, UpdateAgentSettingsErrors, UpdateAgentSettingsResponse, UpdateAgentSettingsResponses, UpdateAssetData, UpdateAssetError, UpdateAssetErrors, UpdateAssetFolderData, UpdateAssetFolderError, UpdateAssetFolderErrors, UpdateAssetFolderResponse, UpdateAssetFolderResponses, UpdateAssetResponse, UpdateAssetResponses, UpdateEndUserData, UpdateEndUserError, UpdateEndUserErrors, UpdateEndUserFactData, UpdateEndUserFactError, UpdateEndUserFactErrors, UpdateEndUserFactResponse, UpdateEndUserFactResponses, UpdateEndUserResponse, UpdateEndUserResponses, UpdateFactData, UpdateFactError, UpdateFactErrors, UpdateFactResponse, UpdateFactResponses, UpdateKnowledgeData, UpdateKnowledgeError, UpdateKnowledgeErrors, UpdateKnowledgeResponse, UpdateKnowledgeResponses, UpdateToolData, UpdateToolError, UpdateToolErrors, UpdateToolResponse, UpdateToolResponses, UpdateVoiceData, UpdateVoiceError, UpdateVoiceErrors, UpdateVoiceResponse, UpdateVoiceResponses, UploadConfirm, UploadTicket, UploadTicketRequest, UsageByKey, UsageDay, UsageResponse, UsageSummary, ValidationIssue, VariantInfo, VideoRequest, VoiceDesignPreview, VoiceDesignRequest, VoiceDesignResult, VoiceDesignSaveRequest, VoiceDetail, VoiceInfo, VoiceInfoPage, VoiceKind, VoiceSample, VoiceSource, VoiceStatus, VoiceUpdate, VoiceUpload, VoiceUploadRequest, VoiceUploadTicket } from './types.gen.js';
|
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -38,6 +38,35 @@ export type ValidationIssue = {
|
|
|
38
38
|
field: string | null;
|
|
39
39
|
message: string;
|
|
40
40
|
};
|
|
41
|
+
export type PlatformLimitPage = {
|
|
42
|
+
data: Array<PlatformLimit>;
|
|
43
|
+
/**
|
|
44
|
+
* Pass as `cursor` for the next page; `null` when this is the last.
|
|
45
|
+
*/
|
|
46
|
+
next_cursor: string | null;
|
|
47
|
+
};
|
|
48
|
+
export type PlatformLimit = {
|
|
49
|
+
/**
|
|
50
|
+
* The limit's name, which this reference's descriptions use for it.
|
|
51
|
+
*/
|
|
52
|
+
key: string;
|
|
53
|
+
/**
|
|
54
|
+
* What it limits, in words.
|
|
55
|
+
*/
|
|
56
|
+
label: string;
|
|
57
|
+
/**
|
|
58
|
+
* The limit in force now, in `unit`.
|
|
59
|
+
*/
|
|
60
|
+
value: number | string | boolean;
|
|
61
|
+
/**
|
|
62
|
+
* What `value` counts; null for a plain count. `credits` are whole credits, not micro-credits.
|
|
63
|
+
*/
|
|
64
|
+
unit: 'ms' | 'seconds' | 'minutes' | 'hours' | 'days' | 'bytes' | 'credits' | null;
|
|
65
|
+
/**
|
|
66
|
+
* The platform's built-in value, which `value` may differ from.
|
|
67
|
+
*/
|
|
68
|
+
default: number | string | boolean;
|
|
69
|
+
};
|
|
41
70
|
export type TemplateInput = {
|
|
42
71
|
/**
|
|
43
72
|
* What to name it in `inputs` when generating.
|
|
@@ -1181,7 +1210,7 @@ export type MessageToolCall = {
|
|
|
1181
1210
|
[key: string]: unknown;
|
|
1182
1211
|
};
|
|
1183
1212
|
/**
|
|
1184
|
-
* What it answered, as the model read it — its JSON, or its text, cut at
|
|
1213
|
+
* What it answered, as the model read it — its JSON, or its text, cut at the platform's `agents.tools.result_max_bytes` (`GET /v1/platform/limits`). Null when it answered nothing.
|
|
1185
1214
|
*/
|
|
1186
1215
|
result?: unknown;
|
|
1187
1216
|
/**
|
|
@@ -1270,7 +1299,7 @@ export type SessionCreateRequest = {
|
|
|
1270
1299
|
/**
|
|
1271
1300
|
* Whether to continue this person's most recent conversation with this agent instead of starting a new one.
|
|
1272
1301
|
*
|
|
1273
|
-
* **Unset is the useful default**: it resumes when this person has a conversation with this agent
|
|
1302
|
+
* **Unset is the useful default**: it resumes when this person has a conversation with this agent young enough to continue — within the organisation's `resume_max_age_days`, else the platform's `agents.sessions.resume_max_age_days` (`GET /v1/platform/limits`) — and starts a new one otherwise. That matches what 'open a conversation with this person' usually means, and it stops an integration that opens a session per page load from scattering somebody's history across a dozen fragments.
|
|
1274
1303
|
*
|
|
1275
1304
|
* `false` always starts a new conversation — this is what a 'new chat' button should send. `true` is the same as leaving it unset; it exists so the intent can be stated rather than implied.
|
|
1276
1305
|
*
|
|
@@ -1514,15 +1543,15 @@ export type AgentSummary = {
|
|
|
1514
1543
|
*/
|
|
1515
1544
|
knowledge_lookup_first: boolean | null;
|
|
1516
1545
|
/**
|
|
1517
|
-
* Pieces of material a lookup hands the model, 1-8. Unset is
|
|
1546
|
+
* Pieces of material a lookup hands the model, 1-8. Unset is the platform's `agents.knowledge.default_results` (`GET /v1/platform/limits`).
|
|
1518
1547
|
*/
|
|
1519
1548
|
knowledge_max_results: number | null;
|
|
1520
1549
|
/**
|
|
1521
|
-
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits
|
|
1550
|
+
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits the platform's `agents.knowledge.inline_budget_tokens` — no lookup, nothing to miss — and looks it up beyond that. `prompt` puts it in the prompt up to the platform's `agents.knowledge.prompt_cap_tokens` (each turn's first word is slower the more there is). `lookup` always looks it up. Both are on `GET /v1/platform/limits`.
|
|
1522
1551
|
*/
|
|
1523
1552
|
knowledge_mode: 'auto' | 'prompt' | 'lookup' | null;
|
|
1524
1553
|
/**
|
|
1525
|
-
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in
|
|
1554
|
+
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in the platform's `agents.memory.recall.budget_chars` (`GET /v1/platform/limits`; 6,000 characters is some 1,500 tokens). When they do not all fit, the ones a conversation confirmed or learnt most recently go in. They are prompt tokens on every turn.
|
|
1526
1555
|
*/
|
|
1527
1556
|
max_facts: number | null;
|
|
1528
1557
|
/**
|
|
@@ -1769,15 +1798,15 @@ export type AgentInfo = {
|
|
|
1769
1798
|
*/
|
|
1770
1799
|
knowledge_lookup_first: boolean | null;
|
|
1771
1800
|
/**
|
|
1772
|
-
* Pieces of material a lookup hands the model, 1-8. Unset is
|
|
1801
|
+
* Pieces of material a lookup hands the model, 1-8. Unset is the platform's `agents.knowledge.default_results` (`GET /v1/platform/limits`).
|
|
1773
1802
|
*/
|
|
1774
1803
|
knowledge_max_results: number | null;
|
|
1775
1804
|
/**
|
|
1776
|
-
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits
|
|
1805
|
+
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits the platform's `agents.knowledge.inline_budget_tokens` — no lookup, nothing to miss — and looks it up beyond that. `prompt` puts it in the prompt up to the platform's `agents.knowledge.prompt_cap_tokens` (each turn's first word is slower the more there is). `lookup` always looks it up. Both are on `GET /v1/platform/limits`.
|
|
1777
1806
|
*/
|
|
1778
1807
|
knowledge_mode: 'auto' | 'prompt' | 'lookup' | null;
|
|
1779
1808
|
/**
|
|
1780
|
-
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in
|
|
1809
|
+
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in the platform's `agents.memory.recall.budget_chars` (`GET /v1/platform/limits`; 6,000 characters is some 1,500 tokens). When they do not all fit, the ones a conversation confirmed or learnt most recently go in. They are prompt tokens on every turn.
|
|
1781
1810
|
*/
|
|
1782
1811
|
max_facts: number | null;
|
|
1783
1812
|
/**
|
|
@@ -1966,15 +1995,15 @@ export type AgentCreateRequest = {
|
|
|
1966
1995
|
*/
|
|
1967
1996
|
knowledge_lookup_first?: boolean | null;
|
|
1968
1997
|
/**
|
|
1969
|
-
* Pieces of material a lookup hands the model, 1-8. Unset is
|
|
1998
|
+
* Pieces of material a lookup hands the model, 1-8. Unset is the platform's `agents.knowledge.default_results` (`GET /v1/platform/limits`).
|
|
1970
1999
|
*/
|
|
1971
2000
|
knowledge_max_results?: number | null;
|
|
1972
2001
|
/**
|
|
1973
|
-
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits
|
|
2002
|
+
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits the platform's `agents.knowledge.inline_budget_tokens` — no lookup, nothing to miss — and looks it up beyond that. `prompt` puts it in the prompt up to the platform's `agents.knowledge.prompt_cap_tokens` (each turn's first word is slower the more there is). `lookup` always looks it up. Both are on `GET /v1/platform/limits`.
|
|
1974
2003
|
*/
|
|
1975
2004
|
knowledge_mode?: 'auto' | 'prompt' | 'lookup' | null;
|
|
1976
2005
|
/**
|
|
1977
|
-
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in
|
|
2006
|
+
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in the platform's `agents.memory.recall.budget_chars` (`GET /v1/platform/limits`; 6,000 characters is some 1,500 tokens). When they do not all fit, the ones a conversation confirmed or learnt most recently go in. They are prompt tokens on every turn.
|
|
1978
2007
|
*/
|
|
1979
2008
|
max_facts?: number | null;
|
|
1980
2009
|
/**
|
|
@@ -1982,7 +2011,7 @@ export type AgentCreateRequest = {
|
|
|
1982
2011
|
*/
|
|
1983
2012
|
max_output_tokens?: number | null;
|
|
1984
2013
|
/**
|
|
1985
|
-
* Gemini model id. Defaults to `
|
|
2014
|
+
* Gemini model id. Defaults to the platform's `agents.model` (`GET /v1/platform/limits`).
|
|
1986
2015
|
*/
|
|
1987
2016
|
model?: string | null;
|
|
1988
2017
|
/**
|
|
@@ -2126,7 +2155,7 @@ export type AgentSettingsInfo = {
|
|
|
2126
2155
|
*
|
|
2127
2156
|
* A conversation continued inside this window gets no fresh opening line, because re-greeting somebody who refreshed the page thirty seconds ago is worse than silence — and costs a model call and a speech call to be worse. Continued outside it, the agent says hello again, which is what a `first_message` direction reading "say hello and catch up with them" is asking for.
|
|
2128
2157
|
*
|
|
2129
|
-
* **Zero means always greet**, on every connection. Clear it (`null`) and the platform
|
|
2158
|
+
* **Zero means always greet**, on every connection. Clear it (`null`) and the platform's `agents.greeting.resume_after_minutes` applies (`GET /v1/platform/limits`).
|
|
2130
2159
|
*
|
|
2131
2160
|
* Organisation-wide: every agent here uses it. It is read when a socket connects, so a change reaches the next connection rather than the ones already open.
|
|
2132
2161
|
*/
|
|
@@ -2136,7 +2165,7 @@ export type AgentSettingsInfo = {
|
|
|
2136
2165
|
*
|
|
2137
2166
|
* Applies to `POST /v1/agent/sessions` when it resumes — see `resume` on that request. Past this, opening a session starts a fresh conversation instead. Nothing is lost at the boundary: durable facts and the standing relationship belong to the person rather than the conversation, and carry into every new one.
|
|
2138
2167
|
*
|
|
2139
|
-
* **Zero means never resume** — every session is a new conversation, which is what an integration that treats a visit as a conversation wants. Clear it (`null`) and the platform
|
|
2168
|
+
* **Zero means never resume** — every session is a new conversation, which is what an integration that treats a visit as a conversation wants. Clear it (`null`) and the platform's `agents.sessions.resume_max_age_days` applies (`GET /v1/platform/limits`).
|
|
2140
2169
|
*/
|
|
2141
2170
|
resume_max_age_days: number | null;
|
|
2142
2171
|
/**
|
|
@@ -2144,7 +2173,7 @@ export type AgentSettingsInfo = {
|
|
|
2144
2173
|
*/
|
|
2145
2174
|
built_in_compact_instruction: string;
|
|
2146
2175
|
/**
|
|
2147
|
-
* The
|
|
2176
|
+
* The platform's mood-reporting instruction, served as it stands so the console never shows a stale copy of it.
|
|
2148
2177
|
*/
|
|
2149
2178
|
built_in_emotion_instruction: string;
|
|
2150
2179
|
/**
|
|
@@ -2152,7 +2181,7 @@ export type AgentSettingsInfo = {
|
|
|
2152
2181
|
*/
|
|
2153
2182
|
built_in_fact_instruction: string;
|
|
2154
2183
|
/**
|
|
2155
|
-
* The
|
|
2184
|
+
* The platform's relationship instruction, served as it stands so the console never shows a stale copy of it.
|
|
2156
2185
|
*/
|
|
2157
2186
|
built_in_relation_instruction: string;
|
|
2158
2187
|
/**
|
|
@@ -2186,7 +2215,7 @@ export type AgentSettingsUpdate = {
|
|
|
2186
2215
|
*
|
|
2187
2216
|
* A conversation continued inside this window gets no fresh opening line, because re-greeting somebody who refreshed the page thirty seconds ago is worse than silence — and costs a model call and a speech call to be worse. Continued outside it, the agent says hello again, which is what a `first_message` direction reading "say hello and catch up with them" is asking for.
|
|
2188
2217
|
*
|
|
2189
|
-
* **Zero means always greet**, on every connection. Clear it (`null`) and the platform
|
|
2218
|
+
* **Zero means always greet**, on every connection. Clear it (`null`) and the platform's `agents.greeting.resume_after_minutes` applies (`GET /v1/platform/limits`).
|
|
2190
2219
|
*
|
|
2191
2220
|
* Organisation-wide: every agent here uses it. It is read when a socket connects, so a change reaches the next connection rather than the ones already open.
|
|
2192
2221
|
*/
|
|
@@ -2196,7 +2225,7 @@ export type AgentSettingsUpdate = {
|
|
|
2196
2225
|
*
|
|
2197
2226
|
* Applies to `POST /v1/agent/sessions` when it resumes — see `resume` on that request. Past this, opening a session starts a fresh conversation instead. Nothing is lost at the boundary: durable facts and the standing relationship belong to the person rather than the conversation, and carry into every new one.
|
|
2198
2227
|
*
|
|
2199
|
-
* **Zero means never resume** — every session is a new conversation, which is what an integration that treats a visit as a conversation wants. Clear it (`null`) and the platform
|
|
2228
|
+
* **Zero means never resume** — every session is a new conversation, which is what an integration that treats a visit as a conversation wants. Clear it (`null`) and the platform's `agents.sessions.resume_max_age_days` applies (`GET /v1/platform/limits`).
|
|
2200
2229
|
*/
|
|
2201
2230
|
resume_max_age_days?: number | null;
|
|
2202
2231
|
};
|
|
@@ -2302,15 +2331,15 @@ export type AgentUpdate = {
|
|
|
2302
2331
|
*/
|
|
2303
2332
|
knowledge_lookup_first?: boolean | null;
|
|
2304
2333
|
/**
|
|
2305
|
-
* Pieces of material a lookup hands the model, 1-8. Unset is
|
|
2334
|
+
* Pieces of material a lookup hands the model, 1-8. Unset is the platform's `agents.knowledge.default_results` (`GET /v1/platform/limits`).
|
|
2306
2335
|
*/
|
|
2307
2336
|
knowledge_max_results?: number | null;
|
|
2308
2337
|
/**
|
|
2309
|
-
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits
|
|
2338
|
+
* How the agent reads its knowledge. `auto` (the default, and what unset means) puts the whole text in the prompt while it fits the platform's `agents.knowledge.inline_budget_tokens` — no lookup, nothing to miss — and looks it up beyond that. `prompt` puts it in the prompt up to the platform's `agents.knowledge.prompt_cap_tokens` (each turn's first word is slower the more there is). `lookup` always looks it up. Both are on `GET /v1/platform/limits`.
|
|
2310
2339
|
*/
|
|
2311
2340
|
knowledge_mode?: 'auto' | 'prompt' | 'lookup' | null;
|
|
2312
2341
|
/**
|
|
2313
|
-
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in
|
|
2342
|
+
* The most of the person's facts put in front of the model, 1-100. Unset is as many as fit in the platform's `agents.memory.recall.budget_chars` (`GET /v1/platform/limits`; 6,000 characters is some 1,500 tokens). When they do not all fit, the ones a conversation confirmed or learnt most recently go in. They are prompt tokens on every turn.
|
|
2314
2343
|
*/
|
|
2315
2344
|
max_facts?: number | null;
|
|
2316
2345
|
/**
|
|
@@ -2318,7 +2347,7 @@ export type AgentUpdate = {
|
|
|
2318
2347
|
*/
|
|
2319
2348
|
max_output_tokens?: number | null;
|
|
2320
2349
|
/**
|
|
2321
|
-
* Gemini model id. `null` or empty returns it to the default, `
|
|
2350
|
+
* Gemini model id. `null` or empty returns it to the default, the platform's `agents.model` (`GET /v1/platform/limits`).
|
|
2322
2351
|
*/
|
|
2323
2352
|
model?: string | null;
|
|
2324
2353
|
/**
|
|
@@ -2540,7 +2569,7 @@ export type KnowledgeSearchResult = {
|
|
|
2540
2569
|
export type KnowledgeSearchHit = {
|
|
2541
2570
|
entry_id: string;
|
|
2542
2571
|
/**
|
|
2543
|
-
* Cosine similarity, 0-1. Nothing under
|
|
2572
|
+
* Cosine similarity, 0-1. Nothing under the platform's `agents.knowledge.min_score` (`GET /v1/platform/limits`) is handed over.
|
|
2544
2573
|
*/
|
|
2545
2574
|
score: number;
|
|
2546
2575
|
/**
|
|
@@ -2824,7 +2853,7 @@ export type ToolInfo = {
|
|
|
2824
2853
|
created_at: string;
|
|
2825
2854
|
updated_at: string;
|
|
2826
2855
|
/**
|
|
2827
|
-
* Its failed calls in your agents' conversations
|
|
2856
|
+
* Its failed calls in your agents' conversations within the platform's `agents.tools.failure_window_minutes` — a deadline missed, an error answered, a server out of reach — counted from the first; 0 once the window passes with none. Each conversation reports its failures at most once in the platform's `agents.tools.report_every_minutes`, so the count can lag by that much. At the platform's `agents.tools.failures_to_mail` in the window, your organisation's admins are mailed, at most once in its `agents.tools.mail_every_hours` per tool. Each is on `GET /v1/platform/limits`.
|
|
2828
2857
|
*/
|
|
2829
2858
|
recent_failures: number;
|
|
2830
2859
|
/**
|
|
@@ -2983,11 +3012,11 @@ export type ToolTestResult = {
|
|
|
2983
3012
|
*/
|
|
2984
3013
|
duration_ms: number;
|
|
2985
3014
|
/**
|
|
2986
|
-
* Its answer: the JSON it sent, else its text, cut at
|
|
3015
|
+
* Its answer: the JSON it sent, else its text, cut at the platform's `agents.tools.result_max_bytes` (`GET /v1/platform/limits`); `null` for none.
|
|
2987
3016
|
*/
|
|
2988
3017
|
result?: unknown;
|
|
2989
3018
|
/**
|
|
2990
|
-
* The answer was longer than
|
|
3019
|
+
* The answer was longer than the platform's `agents.tools.result_max_bytes` and was cut.
|
|
2991
3020
|
*/
|
|
2992
3021
|
truncated: boolean;
|
|
2993
3022
|
/**
|
|
@@ -3013,7 +3042,7 @@ export type ToolsAssigned = {
|
|
|
3013
3042
|
};
|
|
3014
3043
|
export type AgentToolsUpdate = {
|
|
3015
3044
|
/**
|
|
3016
|
-
* The complete set, at most
|
|
3045
|
+
* The complete set, at most the platform's `limits.agent.tools` (`GET /v1/platform/limits`). An empty list turns every tool off.
|
|
3017
3046
|
*/
|
|
3018
3047
|
tool_ids: Array<string>;
|
|
3019
3048
|
};
|
|
@@ -3331,6 +3360,19 @@ export type GetHealthResponses = {
|
|
|
3331
3360
|
200: HealthResponse;
|
|
3332
3361
|
};
|
|
3333
3362
|
export type GetHealthResponse = GetHealthResponses[keyof GetHealthResponses];
|
|
3363
|
+
export type GetPlatformLimitsData = {
|
|
3364
|
+
body?: never;
|
|
3365
|
+
path?: never;
|
|
3366
|
+
query?: never;
|
|
3367
|
+
url: '/v1/platform/limits';
|
|
3368
|
+
};
|
|
3369
|
+
export type GetPlatformLimitsResponses = {
|
|
3370
|
+
/**
|
|
3371
|
+
* Every limit, as it stands now
|
|
3372
|
+
*/
|
|
3373
|
+
200: PlatformLimitPage;
|
|
3374
|
+
};
|
|
3375
|
+
export type GetPlatformLimitsResponse = GetPlatformLimitsResponses[keyof GetPlatformLimitsResponses];
|
|
3334
3376
|
export type GetEphemeralKeyLimitsData = {
|
|
3335
3377
|
body?: never;
|
|
3336
3378
|
path?: never;
|
|
@@ -4440,7 +4482,7 @@ export type CreateAssetUploadUrlErrors = {
|
|
|
4440
4482
|
*/
|
|
4441
4483
|
403: ErrorResponse;
|
|
4442
4484
|
/**
|
|
4443
|
-
* The library holds
|
|
4485
|
+
* The library holds the platform's `limits.org.asset_uploads` uploaded files
|
|
4444
4486
|
*/
|
|
4445
4487
|
409: ErrorResponse;
|
|
4446
4488
|
/**
|
|
@@ -5241,7 +5283,7 @@ export type ListFactsData = {
|
|
|
5241
5283
|
*/
|
|
5242
5284
|
end_user_id?: string;
|
|
5243
5285
|
/**
|
|
5244
|
-
* Also list the facts a later conversation replaced or removed, until they are deleted
|
|
5286
|
+
* Also list the facts a later conversation replaced or removed, until they are deleted, the platform's `agents.memory.facts.replaced_kept_days` later (`GET /v1/platform/limits`).
|
|
5245
5287
|
*/
|
|
5246
5288
|
include_replaced?: boolean;
|
|
5247
5289
|
/**
|
|
@@ -5938,7 +5980,7 @@ export type ListEndUserFactsData = {
|
|
|
5938
5980
|
};
|
|
5939
5981
|
query?: {
|
|
5940
5982
|
/**
|
|
5941
|
-
* Also list the facts a later conversation replaced or removed, until they are deleted
|
|
5983
|
+
* Also list the facts a later conversation replaced or removed, until they are deleted, the platform's `agents.memory.facts.replaced_kept_days` later (`GET /v1/platform/limits`).
|
|
5942
5984
|
*/
|
|
5943
5985
|
include_replaced?: boolean;
|
|
5944
5986
|
/**
|
|
@@ -6879,7 +6921,7 @@ export type CreateToolErrors = {
|
|
|
6879
6921
|
*/
|
|
6880
6922
|
403: ErrorResponse;
|
|
6881
6923
|
/**
|
|
6882
|
-
* A tool by that name exists already, or the library holds
|
|
6924
|
+
* A tool by that name exists already, or the library holds the platform's `limits.org.tools`.
|
|
6883
6925
|
*/
|
|
6884
6926
|
409: ErrorResponse;
|
|
6885
6927
|
/**
|
|
@@ -7492,7 +7534,7 @@ export type CreateVoiceUploadUrlErrors = {
|
|
|
7492
7534
|
*/
|
|
7493
7535
|
403: ErrorResponse;
|
|
7494
7536
|
/**
|
|
7495
|
-
* The organisation already has as many voices as its plan allows
|
|
7537
|
+
* The organisation already has as many voices as its plan allows — never more than the platform's `limits.org.voices` (`GET /v1/platform/limits`) — or the provider's account has no room for another. Delete one, or ask for a higher limit.
|
|
7496
7538
|
*/
|
|
7497
7539
|
409: ErrorResponse;
|
|
7498
7540
|
/**
|
|
@@ -7588,7 +7630,7 @@ export type SaveDesignedVoiceErrors = {
|
|
|
7588
7630
|
*/
|
|
7589
7631
|
403: ErrorResponse;
|
|
7590
7632
|
/**
|
|
7591
|
-
* The organisation already has as many voices as its plan allows
|
|
7633
|
+
* The organisation already has as many voices as its plan allows — never more than the platform's `limits.org.voices` (`GET /v1/platform/limits`) — or the provider's account has no room for another. Delete one, or ask for a higher limit.
|
|
7592
7634
|
*/
|
|
7593
7635
|
409: ErrorResponse;
|
|
7594
7636
|
/**
|
|
@@ -32,7 +32,7 @@ export interface AgentKnowledge {
|
|
|
32
32
|
export interface AgentTools {
|
|
33
33
|
/** Every tool it can call. */
|
|
34
34
|
list(agentId: string, options?: RequestOptions): AsyncGenerator<ToolInfo, void, undefined>;
|
|
35
|
-
/** Replaces them all with these
|
|
35
|
+
/** Replaces them all with these: the platform's `limits.agent.tools` at most (`limits()`). */
|
|
36
36
|
set(agentId: string, body: AgentToolsUpdate, options?: RequestOptions): Promise<ToolsAssigned>;
|
|
37
37
|
}
|
|
38
38
|
export declare class Agents extends Library<AgentInfo, AgentUpdate, AgentSummary, AgentPage, AgentCreateRequest> {
|
|
@@ -2,13 +2,15 @@
|
|
|
2
2
|
* `client.tools`: what an organisation's agents can call while they reply
|
|
3
3
|
* — `/v1/tools*`. A tool is your server (`webhook`), sent a signed `POST`
|
|
4
4
|
* with the call, or the person's app (`app`), called over the agent's
|
|
5
|
-
* socket; each is turned on per agent (`agents.tools.set`),
|
|
5
|
+
* socket; each is turned on per agent (`agents.tools.set`), up to the
|
|
6
|
+
* platform's `limits.agent.tools` (`client.limits()`).
|
|
6
7
|
*
|
|
7
8
|
* - **`create(body)`** answers a webhook's signing secret once, as does
|
|
8
9
|
* `rotateSecret` (`secret`); every call carries `X-Tool-Signature`.
|
|
9
10
|
* - **`test(id, { arguments })`** sends your server one call, signed as a
|
|
10
11
|
* real one, and answers what came back.
|
|
11
|
-
* - **`list()` reads one page**: a library holds
|
|
12
|
+
* - **`list()` reads one page**: a library holds the platform's
|
|
13
|
+
* `limits.org.tools` at most.
|
|
12
14
|
* - **`calls(id, { limit })`** reads its most recent calls in your agents'
|
|
13
15
|
* conversations (100 at most), and each tool carries its
|
|
14
16
|
* `recent_failures`.
|
package/dist/resources/tools.js
CHANGED
|
@@ -2,13 +2,15 @@
|
|
|
2
2
|
* `client.tools`: what an organisation's agents can call while they reply
|
|
3
3
|
* — `/v1/tools*`. A tool is your server (`webhook`), sent a signed `POST`
|
|
4
4
|
* with the call, or the person's app (`app`), called over the agent's
|
|
5
|
-
* socket; each is turned on per agent (`agents.tools.set`),
|
|
5
|
+
* socket; each is turned on per agent (`agents.tools.set`), up to the
|
|
6
|
+
* platform's `limits.agent.tools` (`client.limits()`).
|
|
6
7
|
*
|
|
7
8
|
* - **`create(body)`** answers a webhook's signing secret once, as does
|
|
8
9
|
* `rotateSecret` (`secret`); every call carries `X-Tool-Signature`.
|
|
9
10
|
* - **`test(id, { arguments })`** sends your server one call, signed as a
|
|
10
11
|
* real one, and answers what came back.
|
|
11
|
-
* - **`list()` reads one page**: a library holds
|
|
12
|
+
* - **`list()` reads one page**: a library holds the platform's
|
|
13
|
+
* `limits.org.tools` at most.
|
|
12
14
|
* - **`calls(id, { limit })`** reads its most recent calls in your agents'
|
|
13
15
|
* conversations (100 at most), and each tool carries its
|
|
14
16
|
* `recent_failures`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lumavox/server",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.1",
|
|
4
4
|
"description": "The Lumavox API from your server: end users, ephemeral keys and the rest, typed from the published OpenAPI document. Zero dependencies.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|