@soat/sdk 0.117.0 → 0.118.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +6 -6
- package/dist/index.d.cts +34 -11
- package/dist/index.d.mts +34 -11
- package/dist/index.mjs +6 -6
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -3152,7 +3152,7 @@ var Knowledge = class {
|
|
|
3152
3152
|
/**
|
|
3153
3153
|
* Search knowledge
|
|
3154
3154
|
*
|
|
3155
|
-
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
3155
|
+
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — by the stored vector of an existing document or memory (`similar_to_document_id`, `similar_to_memory_id`), or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `similar_to_document_id`, `similar_to_memory_id`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
3156
3156
|
*/
|
|
3157
3157
|
static searchKnowledge(options) {
|
|
3158
3158
|
return (options.client ?? client).post({
|
|
@@ -4411,7 +4411,7 @@ var Policies = class {
|
|
|
4411
4411
|
/**
|
|
4412
4412
|
* Create a policy
|
|
4413
4413
|
*
|
|
4414
|
-
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400
|
|
4414
|
+
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400`; an `Allow` without `resource` grants every resource of that project. Without a project, creates a global policy, which only the unrestricted admin may.
|
|
4415
4415
|
*/
|
|
4416
4416
|
static createPolicy(options) {
|
|
4417
4417
|
return (options.client ?? client).post({
|
|
@@ -5450,7 +5450,7 @@ var Triggers = class {
|
|
|
5450
5450
|
/**
|
|
5451
5451
|
* Create a trigger
|
|
5452
5452
|
*
|
|
5453
|
-
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `
|
|
5453
|
+
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5454
5454
|
*/
|
|
5455
5455
|
static createTrigger(options) {
|
|
5456
5456
|
return (options.client ?? client).post({
|
|
@@ -5498,7 +5498,7 @@ var Triggers = class {
|
|
|
5498
5498
|
/**
|
|
5499
5499
|
* Update a trigger
|
|
5500
5500
|
*
|
|
5501
|
-
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `
|
|
5501
|
+
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5502
5502
|
*
|
|
5503
5503
|
*/
|
|
5504
5504
|
static updateTrigger(options) {
|
|
@@ -5804,7 +5804,7 @@ var Webhooks = class {
|
|
|
5804
5804
|
/**
|
|
5805
5805
|
* Create a webhook
|
|
5806
5806
|
*
|
|
5807
|
-
* Creates a new webhook for a project
|
|
5807
|
+
* Creates a new webhook for a project. A webhook whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5808
5808
|
*/
|
|
5809
5809
|
static createWebhook(options) {
|
|
5810
5810
|
return (options.client ?? client).post({
|
|
@@ -5841,7 +5841,7 @@ var Webhooks = class {
|
|
|
5841
5841
|
/**
|
|
5842
5842
|
* Update a webhook
|
|
5843
5843
|
*
|
|
5844
|
-
* Updates an existing webhook's configuration
|
|
5844
|
+
* Updates an existing webhook's configuration. An update leaving its `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5845
5845
|
*/
|
|
5846
5846
|
static updateWebhook(options) {
|
|
5847
5847
|
return (options.client ?? client).put({
|
package/dist/index.d.cts
CHANGED
|
@@ -3830,7 +3830,7 @@ type PolicyResourceProperties = {
|
|
|
3830
3830
|
*/
|
|
3831
3831
|
action: Array<string>;
|
|
3832
3832
|
/**
|
|
3833
|
-
* Resource SRN patterns.
|
|
3833
|
+
* Resource SRN patterns. Omitted, an `Allow` matches every resource of the formation's project (`srn:<project_id>:*:*`); a `Deny` matches every resource.
|
|
3834
3834
|
*/
|
|
3835
3835
|
resource?: Array<string> | null;
|
|
3836
3836
|
/**
|
|
@@ -7187,9 +7187,12 @@ type ConfirmPlaybookCaseNodeRequest = {
|
|
|
7187
7187
|
type PolicyStatement = {
|
|
7188
7188
|
effect: 'Allow' | 'Deny';
|
|
7189
7189
|
action: Array<string>;
|
|
7190
|
+
/**
|
|
7191
|
+
* Resource SRN patterns. Omitted, an `Allow` in a project policy matches every resource of the policy's project (`srn:<project_id>:*:*`); anywhere else it matches every resource.
|
|
7192
|
+
*/
|
|
7190
7193
|
resource?: Array<string>;
|
|
7191
7194
|
/**
|
|
7192
|
-
* Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. A context key must be one the platform supplies — `iam:ResourceType` or `iam:
|
|
7195
|
+
* Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. A context key must be one the platform supplies — `iam:ResourceType`, `iam:ResourceTag/<tag>` (the tag on the target resource) or `iam:RequestTag/<key>` (the tag value the request writes) — because an unknown key is absent from the evaluation context, so a `Deny` naming one would never deny. The tag name after the slash is opaque and unconstrained. Operator and context keys are matched by exact string and are never case-converted, so they round-trip exactly as written: `iam:ResourceTag/cost_center` selects the tag `cost_center`, not `costCenter`.
|
|
7193
7196
|
*
|
|
7194
7197
|
*/
|
|
7195
7198
|
condition?: {
|
|
@@ -20534,11 +20537,19 @@ type SearchKnowledgeData = {
|
|
|
20534
20537
|
*/
|
|
20535
20538
|
query?: string;
|
|
20536
20539
|
/**
|
|
20537
|
-
*
|
|
20540
|
+
* Ranks by this document's stored embedding (the mean of its chunk embeddings) instead of a query: the vector channel alone, no embedding call, and none of the document's own chunks in the results. Not combinable with `query` or `similar_to_memory_id`.
|
|
20541
|
+
*/
|
|
20542
|
+
similar_to_document_id?: string;
|
|
20543
|
+
/**
|
|
20544
|
+
* Ranks by this memory's stored embedding instead of a query: the vector channel alone, no embedding call, and the memory itself left out of the results. Not combinable with `query` or `similar_to_document_id`.
|
|
20545
|
+
*/
|
|
20546
|
+
similar_to_memory_id?: string;
|
|
20547
|
+
/**
|
|
20548
|
+
* Minimum raw cosine `similarity_score` a **vector** candidate must reach to take part in ranking, applied before fusion. Only applies when `query` or a `similar_to_*` source is provided. Lexical candidates are deliberately exempt: a result that literally contains the searched token is the evidence, and dropping it for a low cosine is the failure hybrid search exists to prevent. Not a floor on `score`, whose fused value encodes rank position rather than similarity.
|
|
20538
20549
|
*/
|
|
20539
20550
|
min_similarity?: number;
|
|
20540
20551
|
/**
|
|
20541
|
-
* The `k` in the reciprocal rank fusion term `1 / (k + rank)`, which sets how steeply a result's contribution decays with its position in each ranked list. A smaller value weights the very top of each list more heavily. Defaults to the deployment's `KNOWLEDGE_RRF_K`, itself 60 by default. Only applies when `query` is provided.
|
|
20552
|
+
* The `k` in the reciprocal rank fusion term `1 / (k + rank)`, which sets how steeply a result's contribution decays with its position in each ranked list. A smaller value weights the very top of each list more heavily. Defaults to the deployment's `KNOWLEDGE_RRF_K`, itself 60 by default. Only applies when `query` is provided; ignored with a `similar_to_*` source, which ranks by one channel.
|
|
20542
20553
|
*/
|
|
20543
20554
|
rrf_k?: number;
|
|
20544
20555
|
/**
|
|
@@ -20588,7 +20599,7 @@ type SearchKnowledgeData = {
|
|
|
20588
20599
|
};
|
|
20589
20600
|
type SearchKnowledgeErrors = {
|
|
20590
20601
|
/**
|
|
20591
|
-
* Bad request — at least one search parameter is required
|
|
20602
|
+
* Bad request — at least one search parameter is required, and a `similar_to_*` source takes neither `query` nor the other source
|
|
20592
20603
|
*/
|
|
20593
20604
|
400: ErrorResponse;
|
|
20594
20605
|
/**
|
|
@@ -20599,6 +20610,14 @@ type SearchKnowledgeErrors = {
|
|
|
20599
20610
|
* Forbidden, or a `query` and no project in scope the caller holds `embeddings:CreateEmbeddings` on to bill its embedding to
|
|
20600
20611
|
*/
|
|
20601
20612
|
403: ErrorResponse;
|
|
20613
|
+
/**
|
|
20614
|
+
* The `similar_to_*` source does not exist or the caller cannot search it
|
|
20615
|
+
*/
|
|
20616
|
+
404: ErrorResponse;
|
|
20617
|
+
/**
|
|
20618
|
+
* SIMILARITY_SOURCE_NOT_EMBEDDED — the `similar_to_*` source has no embedding yet
|
|
20619
|
+
*/
|
|
20620
|
+
409: ErrorResponse;
|
|
20602
20621
|
/**
|
|
20603
20622
|
* `REQUEST_REJECTED` — the request body is over the size the body parser accepts
|
|
20604
20623
|
*/
|
|
@@ -29080,6 +29099,10 @@ type ListTasksData = {
|
|
|
29080
29099
|
* A `StructuredFilter` over `metadata`, as JSON, url-encoded. It travels as JSON rather than as `key:value` pairs because the match is exact and a query string cannot otherwise say whether `3` is the number or the string.
|
|
29081
29100
|
*/
|
|
29082
29101
|
metadata?: string;
|
|
29102
|
+
/**
|
|
29103
|
+
* Omitted, newest first. `next` lists in pull order: effective priority (the highest `priority` of the task and of every open task it blocks, transitively; `null` below `very_low`), then `readiness.unblocks` descending, then `entered_state_at` oldest first, then `id`. It composes with every filter and answers one page: `limit` applies, a `cursor` is a `400`, and `next_cursor` is `null`.
|
|
29104
|
+
*/
|
|
29105
|
+
order?: 'next';
|
|
29083
29106
|
/**
|
|
29084
29107
|
* Results per page. Above the maximum it is clamped; below 1 or not an integer it is `400 VALIDATION_FAILED`.
|
|
29085
29108
|
*/
|
|
@@ -34338,7 +34361,7 @@ export declare class Knowledge {
|
|
|
34338
34361
|
/**
|
|
34339
34362
|
* Search knowledge
|
|
34340
34363
|
*
|
|
34341
|
-
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
34364
|
+
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — by the stored vector of an existing document or memory (`similar_to_document_id`, `similar_to_memory_id`), or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `similar_to_document_id`, `similar_to_memory_id`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
34342
34365
|
*/
|
|
34343
34366
|
static searchKnowledge<ThrowOnError extends boolean = false>(options: Options<SearchKnowledgeData, ThrowOnError>): RequestResult<SearchKnowledgeResponses, SearchKnowledgeErrors, ThrowOnError>;
|
|
34344
34367
|
}
|
|
@@ -34971,7 +34994,7 @@ export declare class Policies {
|
|
|
34971
34994
|
/**
|
|
34972
34995
|
* Create a policy
|
|
34973
34996
|
*
|
|
34974
|
-
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400
|
|
34997
|
+
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400`; an `Allow` without `resource` grants every resource of that project. Without a project, creates a global policy, which only the unrestricted admin may.
|
|
34975
34998
|
*/
|
|
34976
34999
|
static createPolicy<ThrowOnError extends boolean = false>(options: Options<CreatePolicyData, ThrowOnError>): RequestResult<CreatePolicyResponses, CreatePolicyErrors, ThrowOnError>;
|
|
34977
35000
|
/**
|
|
@@ -35493,7 +35516,7 @@ export declare class Triggers {
|
|
|
35493
35516
|
/**
|
|
35494
35517
|
* Create a trigger
|
|
35495
35518
|
*
|
|
35496
|
-
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `
|
|
35519
|
+
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35497
35520
|
*/
|
|
35498
35521
|
static createTrigger<ThrowOnError extends boolean = false>(options: Options<CreateTriggerData, ThrowOnError>): RequestResult<CreateTriggerResponses, CreateTriggerErrors, ThrowOnError>;
|
|
35499
35522
|
/**
|
|
@@ -35517,7 +35540,7 @@ export declare class Triggers {
|
|
|
35517
35540
|
/**
|
|
35518
35541
|
* Update a trigger
|
|
35519
35542
|
*
|
|
35520
|
-
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `
|
|
35543
|
+
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35521
35544
|
*
|
|
35522
35545
|
*/
|
|
35523
35546
|
static updateTrigger<ThrowOnError extends boolean = false>(options: Options<UpdateTriggerData, ThrowOnError>): RequestResult<UpdateTriggerResponses, UpdateTriggerErrors, ThrowOnError>;
|
|
@@ -35676,7 +35699,7 @@ export declare class Webhooks {
|
|
|
35676
35699
|
/**
|
|
35677
35700
|
* Create a webhook
|
|
35678
35701
|
*
|
|
35679
|
-
* Creates a new webhook for a project
|
|
35702
|
+
* Creates a new webhook for a project. A webhook whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35680
35703
|
*/
|
|
35681
35704
|
static createWebhook<ThrowOnError extends boolean = false>(options: Options<CreateWebhookData, ThrowOnError>): RequestResult<CreateWebhookResponses, CreateWebhookErrors, ThrowOnError>;
|
|
35682
35705
|
/**
|
|
@@ -35694,7 +35717,7 @@ export declare class Webhooks {
|
|
|
35694
35717
|
/**
|
|
35695
35718
|
* Update a webhook
|
|
35696
35719
|
*
|
|
35697
|
-
* Updates an existing webhook's configuration
|
|
35720
|
+
* Updates an existing webhook's configuration. An update leaving its `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35698
35721
|
*/
|
|
35699
35722
|
static updateWebhook<ThrowOnError extends boolean = false>(options: Options<UpdateWebhookData, ThrowOnError>): RequestResult<UpdateWebhookResponses, UpdateWebhookErrors, ThrowOnError>;
|
|
35700
35723
|
/**
|
package/dist/index.d.mts
CHANGED
|
@@ -3830,7 +3830,7 @@ type PolicyResourceProperties = {
|
|
|
3830
3830
|
*/
|
|
3831
3831
|
action: Array<string>;
|
|
3832
3832
|
/**
|
|
3833
|
-
* Resource SRN patterns.
|
|
3833
|
+
* Resource SRN patterns. Omitted, an `Allow` matches every resource of the formation's project (`srn:<project_id>:*:*`); a `Deny` matches every resource.
|
|
3834
3834
|
*/
|
|
3835
3835
|
resource?: Array<string> | null;
|
|
3836
3836
|
/**
|
|
@@ -7187,9 +7187,12 @@ type ConfirmPlaybookCaseNodeRequest = {
|
|
|
7187
7187
|
type PolicyStatement = {
|
|
7188
7188
|
effect: 'Allow' | 'Deny';
|
|
7189
7189
|
action: Array<string>;
|
|
7190
|
+
/**
|
|
7191
|
+
* Resource SRN patterns. Omitted, an `Allow` in a project policy matches every resource of the policy's project (`srn:<project_id>:*:*`); anywhere else it matches every resource.
|
|
7192
|
+
*/
|
|
7190
7193
|
resource?: Array<string>;
|
|
7191
7194
|
/**
|
|
7192
|
-
* Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. A context key must be one the platform supplies — `iam:ResourceType` or `iam:
|
|
7195
|
+
* Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. A context key must be one the platform supplies — `iam:ResourceType`, `iam:ResourceTag/<tag>` (the tag on the target resource) or `iam:RequestTag/<key>` (the tag value the request writes) — because an unknown key is absent from the evaluation context, so a `Deny` naming one would never deny. The tag name after the slash is opaque and unconstrained. Operator and context keys are matched by exact string and are never case-converted, so they round-trip exactly as written: `iam:ResourceTag/cost_center` selects the tag `cost_center`, not `costCenter`.
|
|
7193
7196
|
*
|
|
7194
7197
|
*/
|
|
7195
7198
|
condition?: {
|
|
@@ -20534,11 +20537,19 @@ type SearchKnowledgeData = {
|
|
|
20534
20537
|
*/
|
|
20535
20538
|
query?: string;
|
|
20536
20539
|
/**
|
|
20537
|
-
*
|
|
20540
|
+
* Ranks by this document's stored embedding (the mean of its chunk embeddings) instead of a query: the vector channel alone, no embedding call, and none of the document's own chunks in the results. Not combinable with `query` or `similar_to_memory_id`.
|
|
20541
|
+
*/
|
|
20542
|
+
similar_to_document_id?: string;
|
|
20543
|
+
/**
|
|
20544
|
+
* Ranks by this memory's stored embedding instead of a query: the vector channel alone, no embedding call, and the memory itself left out of the results. Not combinable with `query` or `similar_to_document_id`.
|
|
20545
|
+
*/
|
|
20546
|
+
similar_to_memory_id?: string;
|
|
20547
|
+
/**
|
|
20548
|
+
* Minimum raw cosine `similarity_score` a **vector** candidate must reach to take part in ranking, applied before fusion. Only applies when `query` or a `similar_to_*` source is provided. Lexical candidates are deliberately exempt: a result that literally contains the searched token is the evidence, and dropping it for a low cosine is the failure hybrid search exists to prevent. Not a floor on `score`, whose fused value encodes rank position rather than similarity.
|
|
20538
20549
|
*/
|
|
20539
20550
|
min_similarity?: number;
|
|
20540
20551
|
/**
|
|
20541
|
-
* The `k` in the reciprocal rank fusion term `1 / (k + rank)`, which sets how steeply a result's contribution decays with its position in each ranked list. A smaller value weights the very top of each list more heavily. Defaults to the deployment's `KNOWLEDGE_RRF_K`, itself 60 by default. Only applies when `query` is provided.
|
|
20552
|
+
* The `k` in the reciprocal rank fusion term `1 / (k + rank)`, which sets how steeply a result's contribution decays with its position in each ranked list. A smaller value weights the very top of each list more heavily. Defaults to the deployment's `KNOWLEDGE_RRF_K`, itself 60 by default. Only applies when `query` is provided; ignored with a `similar_to_*` source, which ranks by one channel.
|
|
20542
20553
|
*/
|
|
20543
20554
|
rrf_k?: number;
|
|
20544
20555
|
/**
|
|
@@ -20588,7 +20599,7 @@ type SearchKnowledgeData = {
|
|
|
20588
20599
|
};
|
|
20589
20600
|
type SearchKnowledgeErrors = {
|
|
20590
20601
|
/**
|
|
20591
|
-
* Bad request — at least one search parameter is required
|
|
20602
|
+
* Bad request — at least one search parameter is required, and a `similar_to_*` source takes neither `query` nor the other source
|
|
20592
20603
|
*/
|
|
20593
20604
|
400: ErrorResponse;
|
|
20594
20605
|
/**
|
|
@@ -20599,6 +20610,14 @@ type SearchKnowledgeErrors = {
|
|
|
20599
20610
|
* Forbidden, or a `query` and no project in scope the caller holds `embeddings:CreateEmbeddings` on to bill its embedding to
|
|
20600
20611
|
*/
|
|
20601
20612
|
403: ErrorResponse;
|
|
20613
|
+
/**
|
|
20614
|
+
* The `similar_to_*` source does not exist or the caller cannot search it
|
|
20615
|
+
*/
|
|
20616
|
+
404: ErrorResponse;
|
|
20617
|
+
/**
|
|
20618
|
+
* SIMILARITY_SOURCE_NOT_EMBEDDED — the `similar_to_*` source has no embedding yet
|
|
20619
|
+
*/
|
|
20620
|
+
409: ErrorResponse;
|
|
20602
20621
|
/**
|
|
20603
20622
|
* `REQUEST_REJECTED` — the request body is over the size the body parser accepts
|
|
20604
20623
|
*/
|
|
@@ -29080,6 +29099,10 @@ type ListTasksData = {
|
|
|
29080
29099
|
* A `StructuredFilter` over `metadata`, as JSON, url-encoded. It travels as JSON rather than as `key:value` pairs because the match is exact and a query string cannot otherwise say whether `3` is the number or the string.
|
|
29081
29100
|
*/
|
|
29082
29101
|
metadata?: string;
|
|
29102
|
+
/**
|
|
29103
|
+
* Omitted, newest first. `next` lists in pull order: effective priority (the highest `priority` of the task and of every open task it blocks, transitively; `null` below `very_low`), then `readiness.unblocks` descending, then `entered_state_at` oldest first, then `id`. It composes with every filter and answers one page: `limit` applies, a `cursor` is a `400`, and `next_cursor` is `null`.
|
|
29104
|
+
*/
|
|
29105
|
+
order?: 'next';
|
|
29083
29106
|
/**
|
|
29084
29107
|
* Results per page. Above the maximum it is clamped; below 1 or not an integer it is `400 VALIDATION_FAILED`.
|
|
29085
29108
|
*/
|
|
@@ -34338,7 +34361,7 @@ export declare class Knowledge {
|
|
|
34338
34361
|
/**
|
|
34339
34362
|
* Search knowledge
|
|
34340
34363
|
*
|
|
34341
|
-
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
34364
|
+
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — by the stored vector of an existing document or memory (`similar_to_document_id`, `similar_to_memory_id`), or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `similar_to_document_id`, `similar_to_memory_id`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
34342
34365
|
*/
|
|
34343
34366
|
static searchKnowledge<ThrowOnError extends boolean = false>(options: Options<SearchKnowledgeData, ThrowOnError>): RequestResult<SearchKnowledgeResponses, SearchKnowledgeErrors, ThrowOnError>;
|
|
34344
34367
|
}
|
|
@@ -34971,7 +34994,7 @@ export declare class Policies {
|
|
|
34971
34994
|
/**
|
|
34972
34995
|
* Create a policy
|
|
34973
34996
|
*
|
|
34974
|
-
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400
|
|
34997
|
+
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400`; an `Allow` without `resource` grants every resource of that project. Without a project, creates a global policy, which only the unrestricted admin may.
|
|
34975
34998
|
*/
|
|
34976
34999
|
static createPolicy<ThrowOnError extends boolean = false>(options: Options<CreatePolicyData, ThrowOnError>): RequestResult<CreatePolicyResponses, CreatePolicyErrors, ThrowOnError>;
|
|
34977
35000
|
/**
|
|
@@ -35493,7 +35516,7 @@ export declare class Triggers {
|
|
|
35493
35516
|
/**
|
|
35494
35517
|
* Create a trigger
|
|
35495
35518
|
*
|
|
35496
|
-
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `
|
|
35519
|
+
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35497
35520
|
*/
|
|
35498
35521
|
static createTrigger<ThrowOnError extends boolean = false>(options: Options<CreateTriggerData, ThrowOnError>): RequestResult<CreateTriggerResponses, CreateTriggerErrors, ThrowOnError>;
|
|
35499
35522
|
/**
|
|
@@ -35517,7 +35540,7 @@ export declare class Triggers {
|
|
|
35517
35540
|
/**
|
|
35518
35541
|
* Update a trigger
|
|
35519
35542
|
*
|
|
35520
|
-
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `
|
|
35543
|
+
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35521
35544
|
*
|
|
35522
35545
|
*/
|
|
35523
35546
|
static updateTrigger<ThrowOnError extends boolean = false>(options: Options<UpdateTriggerData, ThrowOnError>): RequestResult<UpdateTriggerResponses, UpdateTriggerErrors, ThrowOnError>;
|
|
@@ -35676,7 +35699,7 @@ export declare class Webhooks {
|
|
|
35676
35699
|
/**
|
|
35677
35700
|
* Create a webhook
|
|
35678
35701
|
*
|
|
35679
|
-
* Creates a new webhook for a project
|
|
35702
|
+
* Creates a new webhook for a project. A webhook whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35680
35703
|
*/
|
|
35681
35704
|
static createWebhook<ThrowOnError extends boolean = false>(options: Options<CreateWebhookData, ThrowOnError>): RequestResult<CreateWebhookResponses, CreateWebhookErrors, ThrowOnError>;
|
|
35682
35705
|
/**
|
|
@@ -35694,7 +35717,7 @@ export declare class Webhooks {
|
|
|
35694
35717
|
/**
|
|
35695
35718
|
* Update a webhook
|
|
35696
35719
|
*
|
|
35697
|
-
* Updates an existing webhook's configuration
|
|
35720
|
+
* Updates an existing webhook's configuration. An update leaving its `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
35698
35721
|
*/
|
|
35699
35722
|
static updateWebhook<ThrowOnError extends boolean = false>(options: Options<UpdateWebhookData, ThrowOnError>): RequestResult<UpdateWebhookResponses, UpdateWebhookErrors, ThrowOnError>;
|
|
35700
35723
|
/**
|
package/dist/index.mjs
CHANGED
|
@@ -3151,7 +3151,7 @@ var Knowledge = class {
|
|
|
3151
3151
|
/**
|
|
3152
3152
|
* Search knowledge
|
|
3153
3153
|
*
|
|
3154
|
-
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
3154
|
+
* Searches across documents and memories using hybrid retrieval — a vector query and a full-text query per source, fused by reciprocal rank — by the stored vector of an existing document or memory (`similar_to_document_id`, `similar_to_memory_id`), or by file paths, document IDs, memory store IDs, or tags. At least one of `query`, `similar_to_document_id`, `similar_to_memory_id`, `tags`, `document_paths`, `document_ids`, or `memory_store_ids` must be provided.
|
|
3155
3155
|
*/
|
|
3156
3156
|
static searchKnowledge(options) {
|
|
3157
3157
|
return (options.client ?? client).post({
|
|
@@ -4410,7 +4410,7 @@ var Policies = class {
|
|
|
4410
4410
|
/**
|
|
4411
4411
|
* Create a policy
|
|
4412
4412
|
*
|
|
4413
|
-
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400
|
|
4413
|
+
* Creates a project policy when `project_id` is given or the credential is bound to a project: its `Allow` statements may name only that project's resources (`srn:<project_id>:<type>:<id>`), else `400`; an `Allow` without `resource` grants every resource of that project. Without a project, creates a global policy, which only the unrestricted admin may.
|
|
4414
4414
|
*/
|
|
4415
4415
|
static createPolicy(options) {
|
|
4416
4416
|
return (options.client ?? client).post({
|
|
@@ -5449,7 +5449,7 @@ var Triggers = class {
|
|
|
5449
5449
|
/**
|
|
5450
5450
|
* Create a trigger
|
|
5451
5451
|
*
|
|
5452
|
-
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `
|
|
5452
|
+
* Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`. An event trigger whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5453
5453
|
*/
|
|
5454
5454
|
static createTrigger(options) {
|
|
5455
5455
|
return (options.client ?? client).post({
|
|
@@ -5497,7 +5497,7 @@ var Triggers = class {
|
|
|
5497
5497
|
/**
|
|
5498
5498
|
* Update a trigger
|
|
5499
5499
|
*
|
|
5500
|
-
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `
|
|
5500
|
+
* Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing acts under the trigger's `policy_ids` rather than the updater's grant. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`. An update leaving an event trigger's `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5501
5501
|
*
|
|
5502
5502
|
*/
|
|
5503
5503
|
static updateTrigger(options) {
|
|
@@ -5803,7 +5803,7 @@ var Webhooks = class {
|
|
|
5803
5803
|
/**
|
|
5804
5804
|
* Create a webhook
|
|
5805
5805
|
*
|
|
5806
|
-
* Creates a new webhook for a project
|
|
5806
|
+
* Creates a new webhook for a project. A webhook whose `policy_ids` cannot read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5807
5807
|
*/
|
|
5808
5808
|
static createWebhook(options) {
|
|
5809
5809
|
return (options.client ?? client).post({
|
|
@@ -5840,7 +5840,7 @@ var Webhooks = class {
|
|
|
5840
5840
|
/**
|
|
5841
5841
|
* Update a webhook
|
|
5842
5842
|
*
|
|
5843
|
-
* Updates an existing webhook's configuration
|
|
5843
|
+
* Updates an existing webhook's configuration. An update leaving its `policy_ids` unable to read a platform namespace its `events` subscribe to is refused with `400` `EVENTS_UNREADABLE`.
|
|
5844
5844
|
*/
|
|
5845
5845
|
static updateWebhook(options) {
|
|
5846
5846
|
return (options.client ?? client).put({
|