@viu/emporix-sdk 4.9.0 → 4.9.2
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/CHANGELOG.md +16 -0
- package/dist/{customer-groups-D7a8BvT2.d.ts → customer-groups-ByyBHCBH.d.ts} +0 -111
- package/dist/{customer-groups-ByNcTPoL.d.cts → customer-groups-ZlnnZrX_.d.cts} +0 -111
- package/dist/customer-groups.d.cts +1 -1
- package/dist/customer-groups.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +138 -15
- package/dist/index.d.ts +138 -15
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.d.cts
CHANGED
|
@@ -23,7 +23,7 @@ import { CompaniesService } from './companies.cjs';
|
|
|
23
23
|
export { LegalEntitySearchInput } from './companies.cjs';
|
|
24
24
|
import { ContactsService } from './contacts.cjs';
|
|
25
25
|
import { LocationsService } from './locations.cjs';
|
|
26
|
-
import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-
|
|
26
|
+
import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-ZlnnZrX_.cjs';
|
|
27
27
|
import { OrdersService, SalesOrdersService } from './orders.cjs';
|
|
28
28
|
export { GetOrderOptions, ListLegalEntityOrdersOptions, ListMyOrdersOptions, ListSalesOrdersOptions, Order, OrderEntry, OrderStatus, OrderTransitionOptions, SalesOrder, SalesOrderCalculationInput, SalesOrderCreateInput, SalesOrderCreated, SalesOrderEntriesInput, SalesOrderHistoricalTransitions, SalesOrderPatch, SalesOrderReplaceInput, SalesOrderSearchInput, SalesOrderSplitInput, SalesOrderSplitResult, Transition, UpdateSalesOrderOptions } from './orders.cjs';
|
|
29
29
|
import { AvailabilityService } from './availability.cjs';
|
|
@@ -1190,6 +1190,10 @@ type MetadataFilter$1 = {
|
|
|
1190
1190
|
* Type of the field.
|
|
1191
1191
|
*/
|
|
1192
1192
|
type?: 'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'date' | 'time' | 'dictionary' | 'list' | 'object';
|
|
1193
|
+
/**
|
|
1194
|
+
* Path of the list of objects that contains this field. Omitted when the field is not inside a list.
|
|
1195
|
+
*/
|
|
1196
|
+
parent?: string;
|
|
1193
1197
|
};
|
|
1194
1198
|
|
|
1195
1199
|
/**
|
|
@@ -2999,8 +3003,9 @@ type ExpandableTokenResponse = IdResponse | ExpandedTokenResponse;
|
|
|
2999
3003
|
* * `rag_custom`
|
|
3000
3004
|
* * `rag_emporix`
|
|
3001
3005
|
* * `teams`
|
|
3006
|
+
* * `search`
|
|
3002
3007
|
*/
|
|
3003
|
-
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams';
|
|
3008
|
+
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams' | 'search';
|
|
3004
3009
|
type BaseNativeTool = {
|
|
3005
3010
|
type: NativeToolType;
|
|
3006
3011
|
/**
|
|
@@ -3125,7 +3130,12 @@ type RagEmporixNativeToolConfig = {
|
|
|
3125
3130
|
*/
|
|
3126
3131
|
prompt: string;
|
|
3127
3132
|
/**
|
|
3128
|
-
* Type of the entity which is stored in the given collection.
|
|
3133
|
+
* Type of the entity which is stored in the given collection. Possible values:
|
|
3134
|
+
* * `product`
|
|
3135
|
+
* * `order`
|
|
3136
|
+
* * `customer`
|
|
3137
|
+
* * `legal-entity`
|
|
3138
|
+
* * a custom entity type defined in the Schema Service
|
|
3129
3139
|
*/
|
|
3130
3140
|
entityType: string;
|
|
3131
3141
|
/**
|
|
@@ -3254,6 +3264,46 @@ type TeamsNativeToolResponse = BaseNativeTool & {
|
|
|
3254
3264
|
config?: TeamsNativeToolConfigResponse;
|
|
3255
3265
|
metadata?: MetadataResponse$1;
|
|
3256
3266
|
};
|
|
3267
|
+
/**
|
|
3268
|
+
* Type of documents the tool searches. Possible values:
|
|
3269
|
+
* * `customer`
|
|
3270
|
+
* * `legal-entity`
|
|
3271
|
+
*/
|
|
3272
|
+
type SearchEntityType = 'customer' | 'legal-entity';
|
|
3273
|
+
/**
|
|
3274
|
+
* Configuration of a search native tool instance.
|
|
3275
|
+
*/
|
|
3276
|
+
type SearchNativeToolConfig = {
|
|
3277
|
+
/**
|
|
3278
|
+
* Instructions for the agent on when and why to call this tool. They are added to the tool description.
|
|
3279
|
+
*/
|
|
3280
|
+
prompt?: string;
|
|
3281
|
+
entityType: SearchEntityType;
|
|
3282
|
+
/**
|
|
3283
|
+
* Maximum number of documents the tool returns for one search.
|
|
3284
|
+
*/
|
|
3285
|
+
maxResults?: number;
|
|
3286
|
+
};
|
|
3287
|
+
type SearchNativeToolRequest = BaseNativeTool & {
|
|
3288
|
+
/**
|
|
3289
|
+
* For `SearchNativeTool`, it has to be set to `search`.
|
|
3290
|
+
*/
|
|
3291
|
+
type?: unknown;
|
|
3292
|
+
config: SearchNativeToolConfig;
|
|
3293
|
+
metadata?: MetadataRequest;
|
|
3294
|
+
};
|
|
3295
|
+
type SearchNativeToolResponse = BaseNativeTool & {
|
|
3296
|
+
/**
|
|
3297
|
+
* Unique identifier of the tool.
|
|
3298
|
+
*/
|
|
3299
|
+
id?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* For `SearchNativeTool`, it has to be set to `search`.
|
|
3302
|
+
*/
|
|
3303
|
+
type?: unknown;
|
|
3304
|
+
config?: SearchNativeToolConfig;
|
|
3305
|
+
metadata?: MetadataResponse$1;
|
|
3306
|
+
};
|
|
3257
3307
|
type RagCustomNativeToolRequest = BaseNativeTool & {
|
|
3258
3308
|
/**
|
|
3259
3309
|
* For `RagCustomNativeTool`, it has to be set to `rag_custom`.
|
|
@@ -3297,7 +3347,7 @@ type RagEmporixNativeToolResponse = BaseNativeTool & {
|
|
|
3297
3347
|
/**
|
|
3298
3348
|
* List of native tools which agents should have access to.
|
|
3299
3349
|
*/
|
|
3300
|
-
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse | TeamsNativeToolResponse>;
|
|
3350
|
+
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse | TeamsNativeToolResponse | SearchNativeToolResponse>;
|
|
3301
3351
|
/**
|
|
3302
3352
|
* Represents an active agent conversation context (MS Teams channel or group chat).
|
|
3303
3353
|
*/
|
|
@@ -4475,7 +4525,7 @@ type QParamSearchBody2 = QParamSearchBody;
|
|
|
4475
4525
|
type McpServerUpsertBody = McpServerRequest;
|
|
4476
4526
|
type TokenUpsertBody = TokenRequest;
|
|
4477
4527
|
type OauthUpsertBody = OAuthRequest;
|
|
4478
|
-
type ToolUpsertBody = SlackNativeToolRequest | RagCustomNativeToolRequest | RagEmporixNativeToolRequest | TeamsNativeToolRequest;
|
|
4528
|
+
type ToolUpsertBody = SlackNativeToolRequest | RagCustomNativeToolRequest | RagEmporixNativeToolRequest | TeamsNativeToolRequest | SearchNativeToolRequest;
|
|
4479
4529
|
|
|
4480
4530
|
/** Single-shot text generation request (`POST /texts`). Has `maxTokens`. */
|
|
4481
4531
|
type TextRequest = TextGenerationRequest;
|
|
@@ -9034,7 +9084,15 @@ type Metadata$3 = {
|
|
|
9034
9084
|
modifiedAt?: string;
|
|
9035
9085
|
};
|
|
9036
9086
|
/**
|
|
9037
|
-
* Entity type
|
|
9087
|
+
* Entity type to reindex. The following values are supported:
|
|
9088
|
+
* * `PRODUCT`
|
|
9089
|
+
* * `ORDER`
|
|
9090
|
+
* * `CUSTOMER`
|
|
9091
|
+
* * `LEGAL-ENTITY`
|
|
9092
|
+
*
|
|
9093
|
+
* You can also use a custom schema type.
|
|
9094
|
+
*
|
|
9095
|
+
* Values are case-insensitive. `LEGAL-ENTITY` uses a hyphen, not an underscore.
|
|
9038
9096
|
*/
|
|
9039
9097
|
type ReindexEntityType$1 = string;
|
|
9040
9098
|
type ReindexJob$1 = {
|
|
@@ -9242,9 +9300,13 @@ type IndexRequest = {
|
|
|
9242
9300
|
/**
|
|
9243
9301
|
* Fields to index. At least one field is required.
|
|
9244
9302
|
*
|
|
9245
|
-
* A string field needs `text`, `autocomplete`, or `exact`. A number, boolean, or date field supports only `exact` set to `true`. `time`, `
|
|
9303
|
+
* A string field needs `text`, `autocomplete`, or `exact`. A number, boolean, or date field supports only `exact` set to `true`. `time`, `object`, and `dictionary` fields cannot be indexed. A list of objects is indexed with `itemFields` on `IndexField`. A path must be a field defined on the type, or `metadata.createdAt`, or `metadata.modifiedAt`. Any other path is rejected.
|
|
9246
9304
|
*/
|
|
9247
9305
|
fields: Array<IndexField>;
|
|
9306
|
+
/**
|
|
9307
|
+
* Named text comparison rules. Optional. Every analyzer must be selected by a field.
|
|
9308
|
+
*/
|
|
9309
|
+
analyzers?: Array<IndexAnalyzer>;
|
|
9248
9310
|
metadata?: IndexMetadataRequest;
|
|
9249
9311
|
};
|
|
9250
9312
|
/**
|
|
@@ -9267,6 +9329,57 @@ type IndexField = {
|
|
|
9267
9329
|
* Indexes the field for equality, list, range, existence, and sort. Required for number, boolean, and date fields.
|
|
9268
9330
|
*/
|
|
9269
9331
|
exact?: boolean;
|
|
9332
|
+
/**
|
|
9333
|
+
* Comparison rules for a string field with `text` set to `true`. Use a preset (`STANDARD`, `FOLDED`, `IDENTIFIER`, `SOUNDS_LIKE`) or the `name` of an analyzer on the index. When omitted, `STANDARD` is used.
|
|
9334
|
+
*/
|
|
9335
|
+
analyzer?: string;
|
|
9336
|
+
/**
|
|
9337
|
+
* Extra comparison rules for the same field. Each entry is a preset or the `name` of an analyzer on the index. A query uses one only when it selects it. Requires `text` set to `true`.
|
|
9338
|
+
*/
|
|
9339
|
+
additionalAnalyzers?: Array<string>;
|
|
9340
|
+
/**
|
|
9341
|
+
* Fields inside one list of objects. `path` is that list. The catalog `parent` of each child must be this path. Matching within one list item uses these fields. Do not set `text`, `autocomplete`, `exact`, or `analyzer` on the list itself.
|
|
9342
|
+
*/
|
|
9343
|
+
itemFields?: Array<IndexField>;
|
|
9344
|
+
};
|
|
9345
|
+
/**
|
|
9346
|
+
* Rules for comparing text. The service applies the same rules to the stored value and to the query. Unknown properties are ignored.
|
|
9347
|
+
*
|
|
9348
|
+
* `basedOn` starts from a preset. A property you set replaces that preset's value. `STANDARD` compares words and ignores case. `FOLDED` also ignores accents. `IDENTIFIER` compares the whole value, ignores case, and removes spaces, `-`, `.`, and `/`. `SOUNDS_LIKE` matches words that sound alike.
|
|
9349
|
+
*/
|
|
9350
|
+
type IndexAnalyzer = {
|
|
9351
|
+
/**
|
|
9352
|
+
* Analyzer name. A letter, then up to 39 letters, digits, underscores, or hyphens. Preset names, `keyword`, and `folded` are reserved.
|
|
9353
|
+
*/
|
|
9354
|
+
name: string;
|
|
9355
|
+
/**
|
|
9356
|
+
* Preset these rules start from.
|
|
9357
|
+
*/
|
|
9358
|
+
basedOn?: 'STANDARD' | 'FOLDED' | 'IDENTIFIER' | 'SOUNDS_LIKE';
|
|
9359
|
+
/**
|
|
9360
|
+
* `WORDS` compares word by word. `WHOLE_VALUE` compares the whole value as one token.
|
|
9361
|
+
*/
|
|
9362
|
+
split?: 'WORDS' | 'WHOLE_VALUE';
|
|
9363
|
+
/**
|
|
9364
|
+
* If set to `true`, upper and lower case are treated as equal.
|
|
9365
|
+
*/
|
|
9366
|
+
ignoreCase?: boolean;
|
|
9367
|
+
/**
|
|
9368
|
+
* If set to `true`, letters with and without accents are treated as equal.
|
|
9369
|
+
*/
|
|
9370
|
+
ignoreAccents?: boolean;
|
|
9371
|
+
/**
|
|
9372
|
+
* Characters removed before comparing. Each entry is one character.
|
|
9373
|
+
*/
|
|
9374
|
+
ignoreCharacters?: Array<string>;
|
|
9375
|
+
/**
|
|
9376
|
+
* Words ignored when comparing. With `WORDS`, each word contains only letters and digits, is at most 50 characters, and must stay one word when text is split. For example, `中文` is two words.
|
|
9377
|
+
*/
|
|
9378
|
+
ignoreWords?: Array<string>;
|
|
9379
|
+
/**
|
|
9380
|
+
* `SPELLING` compares the letters. `SOUND` matches words that sound alike.
|
|
9381
|
+
*/
|
|
9382
|
+
compare?: 'SPELLING' | 'SOUND';
|
|
9270
9383
|
};
|
|
9271
9384
|
/**
|
|
9272
9385
|
* Optimistic lock for an index update. The object can be omitted on create and on update. A missing object still updates an existing index.
|
|
@@ -9284,7 +9397,7 @@ type IndexMetadataRequest = {
|
|
|
9284
9397
|
*/
|
|
9285
9398
|
type IndexSelection = {
|
|
9286
9399
|
/**
|
|
9287
|
-
*
|
|
9400
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9288
9401
|
*/
|
|
9289
9402
|
type: string;
|
|
9290
9403
|
/**
|
|
@@ -9295,7 +9408,7 @@ type IndexSelection = {
|
|
|
9295
9408
|
/**
|
|
9296
9409
|
* Package of search index configuration. `data` is the base64 encoding of a JSON array.
|
|
9297
9410
|
*
|
|
9298
|
-
* Each decoded item has `id`, `type`, and `fields`. `name` and `
|
|
9411
|
+
* Each decoded item has `id`, `type`, and `fields`. `name`, `description`, and `analyzers` are optional. Export omits `status` and `metadata`. Import accepts `metadata.version` when the caller sends it.
|
|
9299
9412
|
*/
|
|
9300
9413
|
type IndexExportPackage = {
|
|
9301
9414
|
/**
|
|
@@ -9316,7 +9429,7 @@ type IndexImportResult = {
|
|
|
9316
9429
|
*/
|
|
9317
9430
|
id: string;
|
|
9318
9431
|
/**
|
|
9319
|
-
*
|
|
9432
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9320
9433
|
*/
|
|
9321
9434
|
type: string;
|
|
9322
9435
|
/**
|
|
@@ -9339,7 +9452,7 @@ type SearchIndex$1 = {
|
|
|
9339
9452
|
*/
|
|
9340
9453
|
id?: string;
|
|
9341
9454
|
/**
|
|
9342
|
-
*
|
|
9455
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9343
9456
|
*/
|
|
9344
9457
|
type?: string;
|
|
9345
9458
|
/**
|
|
@@ -9358,6 +9471,10 @@ type SearchIndex$1 = {
|
|
|
9358
9471
|
* Fields stored for this index.
|
|
9359
9472
|
*/
|
|
9360
9473
|
fields?: Array<IndexField>;
|
|
9474
|
+
/**
|
|
9475
|
+
* Text comparison rules stored for this index. Omitted when the index has none.
|
|
9476
|
+
*/
|
|
9477
|
+
analyzers?: Array<IndexAnalyzer>;
|
|
9361
9478
|
/**
|
|
9362
9479
|
* Build state of the index.
|
|
9363
9480
|
*/
|
|
@@ -9442,7 +9559,7 @@ type SavedSearchCall = {
|
|
|
9442
9559
|
*/
|
|
9443
9560
|
query: string;
|
|
9444
9561
|
/**
|
|
9445
|
-
* Id of the saved search for this
|
|
9562
|
+
* Id of the saved search for this type.
|
|
9446
9563
|
*/
|
|
9447
9564
|
searchQueryId: string;
|
|
9448
9565
|
};
|
|
@@ -9513,7 +9630,7 @@ type SavedQuery = {
|
|
|
9513
9630
|
[key: string]: string;
|
|
9514
9631
|
};
|
|
9515
9632
|
/**
|
|
9516
|
-
*
|
|
9633
|
+
* Type this saved search belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9517
9634
|
*/
|
|
9518
9635
|
type?: string;
|
|
9519
9636
|
/**
|
|
@@ -9542,7 +9659,7 @@ type QueryNode = {
|
|
|
9542
9659
|
*/
|
|
9543
9660
|
query?: string;
|
|
9544
9661
|
/**
|
|
9545
|
-
* Document field to match. `id` is stored as `_id`.
|
|
9662
|
+
* Document field to match. `id` is stored as `_id`. A field inside `itemFields` uses its full path, such as `addresses.city`. Conditions on one list joined by `and` must match the same item. The list path itself cannot be searched.
|
|
9546
9663
|
*/
|
|
9547
9664
|
field?: string;
|
|
9548
9665
|
/**
|
|
@@ -9550,6 +9667,12 @@ type QueryNode = {
|
|
|
9550
9667
|
*/
|
|
9551
9668
|
boost?: number;
|
|
9552
9669
|
fuzzy?: Fuzzy;
|
|
9670
|
+
/**
|
|
9671
|
+
* Optional analyzer for this clause. Allowed only when `type` is `TEXT` or `PHRASE`.
|
|
9672
|
+
*
|
|
9673
|
+
* The value is the field's `analyzer`, or one name from that field's `additionalAnalyzers`. The name is not case-sensitive. When omitted, the query uses the field's `analyzer`.
|
|
9674
|
+
*/
|
|
9675
|
+
analyzer?: string;
|
|
9553
9676
|
};
|
|
9554
9677
|
/**
|
|
9555
9678
|
* Match mode.
|
|
@@ -9588,7 +9711,7 @@ type FilterNode = {
|
|
|
9588
9711
|
*/
|
|
9589
9712
|
or?: Array<FilterNode>;
|
|
9590
9713
|
/**
|
|
9591
|
-
* Document field to compare. `id` is stored as `_id`.
|
|
9714
|
+
* Document field to compare. `id` is stored as `_id`. A field inside `itemFields` uses its full path, such as `addresses.city`. Conditions on one list joined by `and` must match the same item. A lone `NEQ`, `NOT_IN`, or `EXISTS` `false` on a list excludes the document when any item matches the value. A document with no items in that list matches. The same operator joined by `and` with another condition on that list still applies to one item. The list path itself cannot be searched.
|
|
9592
9715
|
*/
|
|
9593
9716
|
field?: string;
|
|
9594
9717
|
operator?: FilterOperator;
|
package/dist/index.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ import { CompaniesService } from './companies.js';
|
|
|
23
23
|
export { LegalEntitySearchInput } from './companies.js';
|
|
24
24
|
import { ContactsService } from './contacts.js';
|
|
25
25
|
import { LocationsService } from './locations.js';
|
|
26
|
-
import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-
|
|
26
|
+
import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-ByyBHCBH.js';
|
|
27
27
|
import { OrdersService, SalesOrdersService } from './orders.js';
|
|
28
28
|
export { GetOrderOptions, ListLegalEntityOrdersOptions, ListMyOrdersOptions, ListSalesOrdersOptions, Order, OrderEntry, OrderStatus, OrderTransitionOptions, SalesOrder, SalesOrderCalculationInput, SalesOrderCreateInput, SalesOrderCreated, SalesOrderEntriesInput, SalesOrderHistoricalTransitions, SalesOrderPatch, SalesOrderReplaceInput, SalesOrderSearchInput, SalesOrderSplitInput, SalesOrderSplitResult, Transition, UpdateSalesOrderOptions } from './orders.js';
|
|
29
29
|
import { AvailabilityService } from './availability.js';
|
|
@@ -1190,6 +1190,10 @@ type MetadataFilter$1 = {
|
|
|
1190
1190
|
* Type of the field.
|
|
1191
1191
|
*/
|
|
1192
1192
|
type?: 'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'date' | 'time' | 'dictionary' | 'list' | 'object';
|
|
1193
|
+
/**
|
|
1194
|
+
* Path of the list of objects that contains this field. Omitted when the field is not inside a list.
|
|
1195
|
+
*/
|
|
1196
|
+
parent?: string;
|
|
1193
1197
|
};
|
|
1194
1198
|
|
|
1195
1199
|
/**
|
|
@@ -2999,8 +3003,9 @@ type ExpandableTokenResponse = IdResponse | ExpandedTokenResponse;
|
|
|
2999
3003
|
* * `rag_custom`
|
|
3000
3004
|
* * `rag_emporix`
|
|
3001
3005
|
* * `teams`
|
|
3006
|
+
* * `search`
|
|
3002
3007
|
*/
|
|
3003
|
-
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams';
|
|
3008
|
+
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams' | 'search';
|
|
3004
3009
|
type BaseNativeTool = {
|
|
3005
3010
|
type: NativeToolType;
|
|
3006
3011
|
/**
|
|
@@ -3125,7 +3130,12 @@ type RagEmporixNativeToolConfig = {
|
|
|
3125
3130
|
*/
|
|
3126
3131
|
prompt: string;
|
|
3127
3132
|
/**
|
|
3128
|
-
* Type of the entity which is stored in the given collection.
|
|
3133
|
+
* Type of the entity which is stored in the given collection. Possible values:
|
|
3134
|
+
* * `product`
|
|
3135
|
+
* * `order`
|
|
3136
|
+
* * `customer`
|
|
3137
|
+
* * `legal-entity`
|
|
3138
|
+
* * a custom entity type defined in the Schema Service
|
|
3129
3139
|
*/
|
|
3130
3140
|
entityType: string;
|
|
3131
3141
|
/**
|
|
@@ -3254,6 +3264,46 @@ type TeamsNativeToolResponse = BaseNativeTool & {
|
|
|
3254
3264
|
config?: TeamsNativeToolConfigResponse;
|
|
3255
3265
|
metadata?: MetadataResponse$1;
|
|
3256
3266
|
};
|
|
3267
|
+
/**
|
|
3268
|
+
* Type of documents the tool searches. Possible values:
|
|
3269
|
+
* * `customer`
|
|
3270
|
+
* * `legal-entity`
|
|
3271
|
+
*/
|
|
3272
|
+
type SearchEntityType = 'customer' | 'legal-entity';
|
|
3273
|
+
/**
|
|
3274
|
+
* Configuration of a search native tool instance.
|
|
3275
|
+
*/
|
|
3276
|
+
type SearchNativeToolConfig = {
|
|
3277
|
+
/**
|
|
3278
|
+
* Instructions for the agent on when and why to call this tool. They are added to the tool description.
|
|
3279
|
+
*/
|
|
3280
|
+
prompt?: string;
|
|
3281
|
+
entityType: SearchEntityType;
|
|
3282
|
+
/**
|
|
3283
|
+
* Maximum number of documents the tool returns for one search.
|
|
3284
|
+
*/
|
|
3285
|
+
maxResults?: number;
|
|
3286
|
+
};
|
|
3287
|
+
type SearchNativeToolRequest = BaseNativeTool & {
|
|
3288
|
+
/**
|
|
3289
|
+
* For `SearchNativeTool`, it has to be set to `search`.
|
|
3290
|
+
*/
|
|
3291
|
+
type?: unknown;
|
|
3292
|
+
config: SearchNativeToolConfig;
|
|
3293
|
+
metadata?: MetadataRequest;
|
|
3294
|
+
};
|
|
3295
|
+
type SearchNativeToolResponse = BaseNativeTool & {
|
|
3296
|
+
/**
|
|
3297
|
+
* Unique identifier of the tool.
|
|
3298
|
+
*/
|
|
3299
|
+
id?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* For `SearchNativeTool`, it has to be set to `search`.
|
|
3302
|
+
*/
|
|
3303
|
+
type?: unknown;
|
|
3304
|
+
config?: SearchNativeToolConfig;
|
|
3305
|
+
metadata?: MetadataResponse$1;
|
|
3306
|
+
};
|
|
3257
3307
|
type RagCustomNativeToolRequest = BaseNativeTool & {
|
|
3258
3308
|
/**
|
|
3259
3309
|
* For `RagCustomNativeTool`, it has to be set to `rag_custom`.
|
|
@@ -3297,7 +3347,7 @@ type RagEmporixNativeToolResponse = BaseNativeTool & {
|
|
|
3297
3347
|
/**
|
|
3298
3348
|
* List of native tools which agents should have access to.
|
|
3299
3349
|
*/
|
|
3300
|
-
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse | TeamsNativeToolResponse>;
|
|
3350
|
+
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse | TeamsNativeToolResponse | SearchNativeToolResponse>;
|
|
3301
3351
|
/**
|
|
3302
3352
|
* Represents an active agent conversation context (MS Teams channel or group chat).
|
|
3303
3353
|
*/
|
|
@@ -4475,7 +4525,7 @@ type QParamSearchBody2 = QParamSearchBody;
|
|
|
4475
4525
|
type McpServerUpsertBody = McpServerRequest;
|
|
4476
4526
|
type TokenUpsertBody = TokenRequest;
|
|
4477
4527
|
type OauthUpsertBody = OAuthRequest;
|
|
4478
|
-
type ToolUpsertBody = SlackNativeToolRequest | RagCustomNativeToolRequest | RagEmporixNativeToolRequest | TeamsNativeToolRequest;
|
|
4528
|
+
type ToolUpsertBody = SlackNativeToolRequest | RagCustomNativeToolRequest | RagEmporixNativeToolRequest | TeamsNativeToolRequest | SearchNativeToolRequest;
|
|
4479
4529
|
|
|
4480
4530
|
/** Single-shot text generation request (`POST /texts`). Has `maxTokens`. */
|
|
4481
4531
|
type TextRequest = TextGenerationRequest;
|
|
@@ -9034,7 +9084,15 @@ type Metadata$3 = {
|
|
|
9034
9084
|
modifiedAt?: string;
|
|
9035
9085
|
};
|
|
9036
9086
|
/**
|
|
9037
|
-
* Entity type
|
|
9087
|
+
* Entity type to reindex. The following values are supported:
|
|
9088
|
+
* * `PRODUCT`
|
|
9089
|
+
* * `ORDER`
|
|
9090
|
+
* * `CUSTOMER`
|
|
9091
|
+
* * `LEGAL-ENTITY`
|
|
9092
|
+
*
|
|
9093
|
+
* You can also use a custom schema type.
|
|
9094
|
+
*
|
|
9095
|
+
* Values are case-insensitive. `LEGAL-ENTITY` uses a hyphen, not an underscore.
|
|
9038
9096
|
*/
|
|
9039
9097
|
type ReindexEntityType$1 = string;
|
|
9040
9098
|
type ReindexJob$1 = {
|
|
@@ -9242,9 +9300,13 @@ type IndexRequest = {
|
|
|
9242
9300
|
/**
|
|
9243
9301
|
* Fields to index. At least one field is required.
|
|
9244
9302
|
*
|
|
9245
|
-
* A string field needs `text`, `autocomplete`, or `exact`. A number, boolean, or date field supports only `exact` set to `true`. `time`, `
|
|
9303
|
+
* A string field needs `text`, `autocomplete`, or `exact`. A number, boolean, or date field supports only `exact` set to `true`. `time`, `object`, and `dictionary` fields cannot be indexed. A list of objects is indexed with `itemFields` on `IndexField`. A path must be a field defined on the type, or `metadata.createdAt`, or `metadata.modifiedAt`. Any other path is rejected.
|
|
9246
9304
|
*/
|
|
9247
9305
|
fields: Array<IndexField>;
|
|
9306
|
+
/**
|
|
9307
|
+
* Named text comparison rules. Optional. Every analyzer must be selected by a field.
|
|
9308
|
+
*/
|
|
9309
|
+
analyzers?: Array<IndexAnalyzer>;
|
|
9248
9310
|
metadata?: IndexMetadataRequest;
|
|
9249
9311
|
};
|
|
9250
9312
|
/**
|
|
@@ -9267,6 +9329,57 @@ type IndexField = {
|
|
|
9267
9329
|
* Indexes the field for equality, list, range, existence, and sort. Required for number, boolean, and date fields.
|
|
9268
9330
|
*/
|
|
9269
9331
|
exact?: boolean;
|
|
9332
|
+
/**
|
|
9333
|
+
* Comparison rules for a string field with `text` set to `true`. Use a preset (`STANDARD`, `FOLDED`, `IDENTIFIER`, `SOUNDS_LIKE`) or the `name` of an analyzer on the index. When omitted, `STANDARD` is used.
|
|
9334
|
+
*/
|
|
9335
|
+
analyzer?: string;
|
|
9336
|
+
/**
|
|
9337
|
+
* Extra comparison rules for the same field. Each entry is a preset or the `name` of an analyzer on the index. A query uses one only when it selects it. Requires `text` set to `true`.
|
|
9338
|
+
*/
|
|
9339
|
+
additionalAnalyzers?: Array<string>;
|
|
9340
|
+
/**
|
|
9341
|
+
* Fields inside one list of objects. `path` is that list. The catalog `parent` of each child must be this path. Matching within one list item uses these fields. Do not set `text`, `autocomplete`, `exact`, or `analyzer` on the list itself.
|
|
9342
|
+
*/
|
|
9343
|
+
itemFields?: Array<IndexField>;
|
|
9344
|
+
};
|
|
9345
|
+
/**
|
|
9346
|
+
* Rules for comparing text. The service applies the same rules to the stored value and to the query. Unknown properties are ignored.
|
|
9347
|
+
*
|
|
9348
|
+
* `basedOn` starts from a preset. A property you set replaces that preset's value. `STANDARD` compares words and ignores case. `FOLDED` also ignores accents. `IDENTIFIER` compares the whole value, ignores case, and removes spaces, `-`, `.`, and `/`. `SOUNDS_LIKE` matches words that sound alike.
|
|
9349
|
+
*/
|
|
9350
|
+
type IndexAnalyzer = {
|
|
9351
|
+
/**
|
|
9352
|
+
* Analyzer name. A letter, then up to 39 letters, digits, underscores, or hyphens. Preset names, `keyword`, and `folded` are reserved.
|
|
9353
|
+
*/
|
|
9354
|
+
name: string;
|
|
9355
|
+
/**
|
|
9356
|
+
* Preset these rules start from.
|
|
9357
|
+
*/
|
|
9358
|
+
basedOn?: 'STANDARD' | 'FOLDED' | 'IDENTIFIER' | 'SOUNDS_LIKE';
|
|
9359
|
+
/**
|
|
9360
|
+
* `WORDS` compares word by word. `WHOLE_VALUE` compares the whole value as one token.
|
|
9361
|
+
*/
|
|
9362
|
+
split?: 'WORDS' | 'WHOLE_VALUE';
|
|
9363
|
+
/**
|
|
9364
|
+
* If set to `true`, upper and lower case are treated as equal.
|
|
9365
|
+
*/
|
|
9366
|
+
ignoreCase?: boolean;
|
|
9367
|
+
/**
|
|
9368
|
+
* If set to `true`, letters with and without accents are treated as equal.
|
|
9369
|
+
*/
|
|
9370
|
+
ignoreAccents?: boolean;
|
|
9371
|
+
/**
|
|
9372
|
+
* Characters removed before comparing. Each entry is one character.
|
|
9373
|
+
*/
|
|
9374
|
+
ignoreCharacters?: Array<string>;
|
|
9375
|
+
/**
|
|
9376
|
+
* Words ignored when comparing. With `WORDS`, each word contains only letters and digits, is at most 50 characters, and must stay one word when text is split. For example, `中文` is two words.
|
|
9377
|
+
*/
|
|
9378
|
+
ignoreWords?: Array<string>;
|
|
9379
|
+
/**
|
|
9380
|
+
* `SPELLING` compares the letters. `SOUND` matches words that sound alike.
|
|
9381
|
+
*/
|
|
9382
|
+
compare?: 'SPELLING' | 'SOUND';
|
|
9270
9383
|
};
|
|
9271
9384
|
/**
|
|
9272
9385
|
* Optimistic lock for an index update. The object can be omitted on create and on update. A missing object still updates an existing index.
|
|
@@ -9284,7 +9397,7 @@ type IndexMetadataRequest = {
|
|
|
9284
9397
|
*/
|
|
9285
9398
|
type IndexSelection = {
|
|
9286
9399
|
/**
|
|
9287
|
-
*
|
|
9400
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9288
9401
|
*/
|
|
9289
9402
|
type: string;
|
|
9290
9403
|
/**
|
|
@@ -9295,7 +9408,7 @@ type IndexSelection = {
|
|
|
9295
9408
|
/**
|
|
9296
9409
|
* Package of search index configuration. `data` is the base64 encoding of a JSON array.
|
|
9297
9410
|
*
|
|
9298
|
-
* Each decoded item has `id`, `type`, and `fields`. `name` and `
|
|
9411
|
+
* Each decoded item has `id`, `type`, and `fields`. `name`, `description`, and `analyzers` are optional. Export omits `status` and `metadata`. Import accepts `metadata.version` when the caller sends it.
|
|
9299
9412
|
*/
|
|
9300
9413
|
type IndexExportPackage = {
|
|
9301
9414
|
/**
|
|
@@ -9316,7 +9429,7 @@ type IndexImportResult = {
|
|
|
9316
9429
|
*/
|
|
9317
9430
|
id: string;
|
|
9318
9431
|
/**
|
|
9319
|
-
*
|
|
9432
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9320
9433
|
*/
|
|
9321
9434
|
type: string;
|
|
9322
9435
|
/**
|
|
@@ -9339,7 +9452,7 @@ type SearchIndex$1 = {
|
|
|
9339
9452
|
*/
|
|
9340
9453
|
id?: string;
|
|
9341
9454
|
/**
|
|
9342
|
-
*
|
|
9455
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9343
9456
|
*/
|
|
9344
9457
|
type?: string;
|
|
9345
9458
|
/**
|
|
@@ -9358,6 +9471,10 @@ type SearchIndex$1 = {
|
|
|
9358
9471
|
* Fields stored for this index.
|
|
9359
9472
|
*/
|
|
9360
9473
|
fields?: Array<IndexField>;
|
|
9474
|
+
/**
|
|
9475
|
+
* Text comparison rules stored for this index. Omitted when the index has none.
|
|
9476
|
+
*/
|
|
9477
|
+
analyzers?: Array<IndexAnalyzer>;
|
|
9361
9478
|
/**
|
|
9362
9479
|
* Build state of the index.
|
|
9363
9480
|
*/
|
|
@@ -9442,7 +9559,7 @@ type SavedSearchCall = {
|
|
|
9442
9559
|
*/
|
|
9443
9560
|
query: string;
|
|
9444
9561
|
/**
|
|
9445
|
-
* Id of the saved search for this
|
|
9562
|
+
* Id of the saved search for this type.
|
|
9446
9563
|
*/
|
|
9447
9564
|
searchQueryId: string;
|
|
9448
9565
|
};
|
|
@@ -9513,7 +9630,7 @@ type SavedQuery = {
|
|
|
9513
9630
|
[key: string]: string;
|
|
9514
9631
|
};
|
|
9515
9632
|
/**
|
|
9516
|
-
*
|
|
9633
|
+
* Type this saved search belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9517
9634
|
*/
|
|
9518
9635
|
type?: string;
|
|
9519
9636
|
/**
|
|
@@ -9542,7 +9659,7 @@ type QueryNode = {
|
|
|
9542
9659
|
*/
|
|
9543
9660
|
query?: string;
|
|
9544
9661
|
/**
|
|
9545
|
-
* Document field to match. `id` is stored as `_id`.
|
|
9662
|
+
* Document field to match. `id` is stored as `_id`. A field inside `itemFields` uses its full path, such as `addresses.city`. Conditions on one list joined by `and` must match the same item. The list path itself cannot be searched.
|
|
9546
9663
|
*/
|
|
9547
9664
|
field?: string;
|
|
9548
9665
|
/**
|
|
@@ -9550,6 +9667,12 @@ type QueryNode = {
|
|
|
9550
9667
|
*/
|
|
9551
9668
|
boost?: number;
|
|
9552
9669
|
fuzzy?: Fuzzy;
|
|
9670
|
+
/**
|
|
9671
|
+
* Optional analyzer for this clause. Allowed only when `type` is `TEXT` or `PHRASE`.
|
|
9672
|
+
*
|
|
9673
|
+
* The value is the field's `analyzer`, or one name from that field's `additionalAnalyzers`. The name is not case-sensitive. When omitted, the query uses the field's `analyzer`.
|
|
9674
|
+
*/
|
|
9675
|
+
analyzer?: string;
|
|
9553
9676
|
};
|
|
9554
9677
|
/**
|
|
9555
9678
|
* Match mode.
|
|
@@ -9588,7 +9711,7 @@ type FilterNode = {
|
|
|
9588
9711
|
*/
|
|
9589
9712
|
or?: Array<FilterNode>;
|
|
9590
9713
|
/**
|
|
9591
|
-
* Document field to compare. `id` is stored as `_id`.
|
|
9714
|
+
* Document field to compare. `id` is stored as `_id`. A field inside `itemFields` uses its full path, such as `addresses.city`. Conditions on one list joined by `and` must match the same item. A lone `NEQ`, `NOT_IN`, or `EXISTS` `false` on a list excludes the document when any item matches the value. A document with no items in that list matches. The same operator joined by `and` with another condition on that list still applies to one item. The list path itself cannot be searched.
|
|
9592
9715
|
*/
|
|
9593
9716
|
field?: string;
|
|
9594
9717
|
operator?: FilterOperator;
|