@orq-ai/node 4.16.0-rc.23 → 4.16.0-rc.25

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.
Files changed (152) hide show
  1. package/README.md +10 -10
  2. package/funcs/knowledgeCreate.d.ts +1 -1
  3. package/funcs/knowledgeCreate.js +1 -1
  4. package/funcs/knowledgeDelete.d.ts +1 -1
  5. package/funcs/knowledgeDelete.js +1 -1
  6. package/funcs/knowledgeDeleteDatasource.d.ts +1 -1
  7. package/funcs/knowledgeDeleteDatasource.js +1 -1
  8. package/funcs/knowledgeRetrieve.d.ts +1 -1
  9. package/funcs/knowledgeRetrieve.js +1 -1
  10. package/funcs/knowledgeUpdate.d.ts +1 -1
  11. package/funcs/knowledgeUpdate.js +1 -1
  12. package/funcs/modelsUpdateAwsBedrock.d.ts +1 -1
  13. package/funcs/modelsUpdateAwsBedrock.js +1 -1
  14. package/funcs/tracesQuery.d.ts +1 -1
  15. package/funcs/tracesQuery.js +1 -1
  16. package/jsr.json +1 -1
  17. package/lib/config.d.ts +2 -2
  18. package/lib/config.js +2 -2
  19. package/models/components/budgetlimits.d.ts +2 -4
  20. package/models/components/budgetlimits.d.ts.map +1 -1
  21. package/models/components/budgetlimits.js.map +1 -1
  22. package/models/components/budgetlimitsrestresponse.d.ts +2 -4
  23. package/models/components/budgetlimitsrestresponse.d.ts.map +1 -1
  24. package/models/components/budgetlimitsrestresponse.js.map +1 -1
  25. package/models/components/budgetrestresponse.d.ts +11 -12
  26. package/models/components/budgetrestresponse.d.ts.map +1 -1
  27. package/models/components/budgetrestresponse.js.map +1 -1
  28. package/models/components/budgetscope.d.ts +1 -1
  29. package/models/components/budgetscoperestresponse.d.ts +1 -1
  30. package/models/components/datapoint.d.ts +3 -5
  31. package/models/components/datapoint.d.ts.map +1 -1
  32. package/models/components/datapoint.js.map +1 -1
  33. package/models/components/identity.d.ts +11 -12
  34. package/models/components/identity.d.ts.map +1 -1
  35. package/models/components/identity.js.map +1 -1
  36. package/models/components/index.d.ts +1 -1
  37. package/models/components/index.d.ts.map +1 -1
  38. package/models/components/index.js +1 -1
  39. package/models/components/index.js.map +1 -1
  40. package/models/components/knowledgesettings.d.ts +2 -2
  41. package/models/components/knowledgesettings.d.ts.map +1 -1
  42. package/models/components/knowledgesettings.js +2 -2
  43. package/models/components/knowledgesettings.js.map +1 -1
  44. package/models/components/memorystoreembeddingconfig.d.ts +1 -1
  45. package/models/components/modelbudgetscope.d.ts +1 -1
  46. package/models/components/modelbudgetscoperestresponse.d.ts +1 -1
  47. package/models/components/project.d.ts +1 -4
  48. package/models/components/project.d.ts.map +1 -1
  49. package/models/components/project.js.map +1 -1
  50. package/models/components/ratelimit.d.ts +2 -2
  51. package/models/components/ratelimitrestresponse.d.ts +2 -2
  52. package/models/components/reasoningpart.js +1 -1
  53. package/models/components/responsemeta.d.ts +3 -3
  54. package/models/components/responsemeta.js +1 -1
  55. package/models/components/{internalretrievalconfig.d.ts → retrievalconfig.d.ts} +4 -4
  56. package/models/components/retrievalconfig.d.ts.map +1 -0
  57. package/models/components/{internalretrievalconfig.js → retrievalconfig.js} +6 -6
  58. package/models/components/retrievalconfig.js.map +1 -0
  59. package/models/components/searchknowledgerequest.d.ts +4 -4
  60. package/models/components/searchlogsresponse.d.ts +2 -2
  61. package/models/components/searchrerankconfig.d.ts +1 -1
  62. package/models/components/sharing.d.ts +2 -3
  63. package/models/components/sharing.d.ts.map +1 -1
  64. package/models/components/sharing.js.map +1 -1
  65. package/models/operations/createagentrequest.d.ts +1 -1
  66. package/models/operations/createchatcompletion.d.ts +5 -5
  67. package/models/operations/createcompletion.d.ts +4 -4
  68. package/models/operations/createimage.d.ts +1 -1
  69. package/models/operations/createimageedit.d.ts +1 -1
  70. package/models/operations/createprompt.d.ts +1 -1
  71. package/models/operations/createtool.js +4 -4
  72. package/models/operations/getalltools.js +4 -4
  73. package/models/operations/getv2humanevalsets.js +2 -2
  74. package/models/operations/getv2humanevalsetsid.js +2 -2
  75. package/models/operations/listagents.d.ts +1 -1
  76. package/models/operations/parse.d.ts +3 -3
  77. package/models/operations/patchv2humanevalsetsid.js +2 -2
  78. package/models/operations/postv2feedbackevaluation.js +4 -4
  79. package/models/operations/postv2humanevalsets.js +2 -2
  80. package/models/operations/retrieveagentrequest.d.ts +1 -1
  81. package/models/operations/retrievetool.js +4 -4
  82. package/models/operations/runagent.js +1 -1
  83. package/models/operations/skilllist.d.ts +2 -2
  84. package/models/operations/streamrunagent.js +1 -1
  85. package/models/operations/updateagent.d.ts +1 -1
  86. package/models/operations/updateprompt.d.ts +1 -1
  87. package/models/operations/updatetool.js +4 -4
  88. package/package.json +6 -6
  89. package/sdk/knowledge.d.ts +5 -5
  90. package/sdk/knowledge.js +5 -5
  91. package/sdk/models.d.ts +1 -1
  92. package/sdk/models.js +1 -1
  93. package/sdk/traces.d.ts +1 -1
  94. package/sdk/traces.js +1 -1
  95. package/src/funcs/knowledgeCreate.ts +1 -1
  96. package/src/funcs/knowledgeDelete.ts +1 -1
  97. package/src/funcs/knowledgeDeleteDatasource.ts +1 -1
  98. package/src/funcs/knowledgeRetrieve.ts +1 -1
  99. package/src/funcs/knowledgeUpdate.ts +1 -1
  100. package/src/funcs/modelsUpdateAwsBedrock.ts +1 -1
  101. package/src/funcs/tracesQuery.ts +1 -1
  102. package/src/lib/config.ts +2 -2
  103. package/src/models/components/budgetlimits.ts +2 -4
  104. package/src/models/components/budgetlimitsrestresponse.ts +2 -4
  105. package/src/models/components/budgetrestresponse.ts +11 -12
  106. package/src/models/components/budgetscope.ts +1 -1
  107. package/src/models/components/budgetscoperestresponse.ts +1 -1
  108. package/src/models/components/datapoint.ts +3 -5
  109. package/src/models/components/identity.ts +11 -12
  110. package/src/models/components/index.ts +1 -1
  111. package/src/models/components/knowledgesettings.ts +5 -5
  112. package/src/models/components/memorystoreembeddingconfig.ts +1 -1
  113. package/src/models/components/modelbudgetscope.ts +1 -1
  114. package/src/models/components/modelbudgetscoperestresponse.ts +1 -1
  115. package/src/models/components/project.ts +1 -4
  116. package/src/models/components/ratelimit.ts +2 -2
  117. package/src/models/components/ratelimitrestresponse.ts +2 -2
  118. package/src/models/components/reasoningpart.ts +1 -1
  119. package/src/models/components/responsemeta.ts +3 -3
  120. package/src/models/components/{internalretrievalconfig.ts → retrievalconfig.ts} +7 -7
  121. package/src/models/components/searchknowledgerequest.ts +4 -4
  122. package/src/models/components/searchlogsresponse.ts +2 -2
  123. package/src/models/components/searchrerankconfig.ts +1 -1
  124. package/src/models/components/sharing.ts +2 -3
  125. package/src/models/operations/createagentrequest.ts +1 -1
  126. package/src/models/operations/createchatcompletion.ts +5 -5
  127. package/src/models/operations/createcompletion.ts +4 -4
  128. package/src/models/operations/createimage.ts +1 -1
  129. package/src/models/operations/createimageedit.ts +1 -1
  130. package/src/models/operations/createprompt.ts +1 -1
  131. package/src/models/operations/createtool.ts +4 -4
  132. package/src/models/operations/getalltools.ts +4 -4
  133. package/src/models/operations/getv2humanevalsets.ts +2 -2
  134. package/src/models/operations/getv2humanevalsetsid.ts +2 -2
  135. package/src/models/operations/listagents.ts +1 -1
  136. package/src/models/operations/parse.ts +3 -3
  137. package/src/models/operations/patchv2humanevalsetsid.ts +2 -2
  138. package/src/models/operations/postv2feedbackevaluation.ts +4 -4
  139. package/src/models/operations/postv2humanevalsets.ts +2 -2
  140. package/src/models/operations/retrieveagentrequest.ts +1 -1
  141. package/src/models/operations/retrievetool.ts +4 -4
  142. package/src/models/operations/runagent.ts +1 -1
  143. package/src/models/operations/skilllist.ts +2 -2
  144. package/src/models/operations/streamrunagent.ts +1 -1
  145. package/src/models/operations/updateagent.ts +1 -1
  146. package/src/models/operations/updateprompt.ts +1 -1
  147. package/src/models/operations/updatetool.ts +4 -4
  148. package/src/sdk/knowledge.ts +5 -5
  149. package/src/sdk/models.ts +1 -1
  150. package/src/sdk/traces.ts +1 -1
  151. package/models/components/internalretrievalconfig.d.ts.map +0 -1
  152. package/models/components/internalretrievalconfig.js.map +0 -1
@@ -9,13 +9,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  export type DataPoint = {
11
11
  /**
12
- * Bucket start in UTC, RFC 3339. Clients that need epoch ms can call
12
+ * Bucket start in UTC, RFC 3339. Clients that need epoch milliseconds
13
13
  *
14
14
  * @remarks
15
- * `Date.parse(timestamp)` or `new Date(timestamp).getTime()` —
16
- * returning the int64 in JSON would force a string (protojson rule)
17
- * and force callers to coerce anyway, so we ship ISO only. Unset for
18
- * `mode=scalar` rows, which aggregate the whole window.
15
+ * can derive them from this value. Unset for `mode=scalar` rows, which
16
+ * aggregate the whole window.
19
17
  */
20
18
  timestamp?: Date | undefined;
21
19
  /**
@@ -30,23 +30,22 @@ import { RateLimit, RateLimit$inboundSchema } from "./ratelimit.js";
30
30
  export type Budget = {
31
31
  budgetId: string;
32
32
  /**
33
- * Denormalized metadata for UI rendering, list filters, and the
33
+ * Scope the budget was created for, used to group and filter budgets in
34
34
  *
35
35
  * @remarks
36
- * resolver's prefilter index. Never consulted for matching — the
37
- * `match` expression is the single source of matching semantics.
38
- * Unset for budgets created from a raw CEL expression ("custom").
36
+ * the console. Not used for matching: the `match` expression decides
37
+ * which requests a budget applies to. Unset for budgets created from a
38
+ * raw CEL expression ("custom").
39
39
  */
40
40
  scope?: BudgetScope | undefined;
41
41
  /**
42
- * The matching semantics of the budget. The enforcement resolver
42
+ * The matching semantics of the budget. A budget applies to a request
43
43
  *
44
44
  * @remarks
45
- * evaluates `match.cel` against the request context; a budget
46
- * applies to a request if and only if the expression evaluates to
47
- * true. Scoped creates derive a canonical expression (e.g.
48
- * `provider == "openai"`); an empty expression always matches
49
- * (workspace-wide).
45
+ * when `match.cel` evaluates to true against the request context.
46
+ * Creating a budget for a scope derives the expression for that scope
47
+ * (e.g. `provider == "openai"`); an empty expression matches every
48
+ * request in the workspace.
50
49
  */
51
50
  match?: BudgetMatch | undefined;
52
51
  /**
@@ -58,10 +57,10 @@ export type Budget = {
58
57
  */
59
58
  limits: BudgetLimits;
60
59
  /**
61
- * RateLimit is the per-minute request ceiling. Enforced via atomic
60
+ * Per-minute request ceiling applied to the requests this budget
62
61
  *
63
62
  * @remarks
64
- * increment-first semantics in the enforcement middleware.
63
+ * matches.
65
64
  */
66
65
  rateLimit?: RateLimit | undefined;
67
66
  isActive?: boolean | undefined;
@@ -276,7 +276,6 @@ export * from "./incompletedetails.js";
276
276
  export * from "./inputtokensdetails.js";
277
277
  export * from "./inspectrepositorywikirequest.js";
278
278
  export * from "./inspectrepositorywikiresponse.js";
279
- export * from "./internalretrievalconfig.js";
280
279
  export * from "./invokedeploymentrequest.js";
281
280
  export * from "./invokeevaluatorrequest.js";
282
281
  export * from "./ipallowlist.js";
@@ -545,6 +544,7 @@ export * from "./responsewebsearchcallinprogressstreamevent.js";
545
544
  export * from "./responsewebsearchcallsearchingstreamevent.js";
546
545
  export * from "./restorerequest.js";
547
546
  export * from "./restoreresponse.js";
547
+ export * from "./retrievalconfig.js";
548
548
  export * from "./retrieveagentstoolinput.js";
549
549
  export * from "./retrieveidentityresponse.js";
550
550
  export * from "./retrieveknowledgebasestoolinput.js";
@@ -16,13 +16,13 @@ import {
16
16
  EmbeddingsConfig$inboundSchema,
17
17
  } from "./embeddingsconfig.js";
18
18
  import {
19
- InternalRetrievalConfig,
20
- InternalRetrievalConfig$inboundSchema,
21
- } from "./internalretrievalconfig.js";
19
+ RetrievalConfig,
20
+ RetrievalConfig$inboundSchema,
21
+ } from "./retrievalconfig.js";
22
22
 
23
23
  export type KnowledgeSettings = {
24
24
  embeddingsConfig?: EmbeddingsConfig | undefined;
25
- retrievalConfig?: InternalRetrievalConfig | undefined;
25
+ retrievalConfig?: RetrievalConfig | undefined;
26
26
  agenticRagConfig?: AgenticRagConfig | undefined;
27
27
  };
28
28
 
@@ -33,7 +33,7 @@ export const KnowledgeSettings$inboundSchema: z.ZodType<
33
33
  unknown
34
34
  > = z.object({
35
35
  embeddings_config: EmbeddingsConfig$inboundSchema.optional(),
36
- retrieval_config: InternalRetrievalConfig$inboundSchema.optional(),
36
+ retrieval_config: RetrievalConfig$inboundSchema.optional(),
37
37
  agentic_rag_config: AgenticRagConfig$inboundSchema.optional(),
38
38
  }).transform((v) => {
39
39
  return remap$(v, {
@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  export type MemoryStoreEmbeddingConfig = {
11
11
  /**
12
- * The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the [Supported models](/docs/ai-gateway/supported-models) to browse available models.
12
+ * The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the [Supported models](/ai-gateway/supported-models) to browse available models.
13
13
  */
14
14
  model: string;
15
15
  };
@@ -13,7 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
13
13
  *
14
14
  * @remarks
15
15
  * it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
16
- * models), rather than an internal identifier.
16
+ * models).
17
17
  */
18
18
  export type ModelBudgetScope = {
19
19
  modelId: string;
@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
12
12
  *
13
13
  * @remarks
14
14
  * it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
15
- * models), rather than an internal identifier.
15
+ * models).
16
16
  */
17
17
  export type ModelBudgetScopeRestResponse = {
18
18
  modelId: string;
@@ -21,10 +21,7 @@ export type Project = {
21
21
  */
22
22
  name: string;
23
23
  /**
24
- * Stable project key generated from the name and used by internal
25
- *
26
- * @remarks
27
- * workspace navigation.
24
+ * Stable project key generated from the name.
28
25
  */
29
26
  key: string;
30
27
  /**
@@ -9,10 +9,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * RateLimit is the per-minute request ceiling. Enforced via atomic
12
+ * Per-minute request ceiling applied to the requests this budget
13
13
  *
14
14
  * @remarks
15
- * increment-first semantics in the enforcement middleware.
15
+ * matches.
16
16
  */
17
17
  export type RateLimit = {
18
18
  requestsPerMinute?: number | undefined;
@@ -8,10 +8,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
8
8
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  /**
11
- * RateLimit is the per-minute request ceiling. Enforced via atomic
11
+ * Per-minute request ceiling applied to the requests this budget
12
12
  *
13
13
  * @remarks
14
- * increment-first semantics in the enforcement middleware.
14
+ * matches.
15
15
  */
16
16
  export type RateLimitRestResponse = {
17
17
  requestsPerMinute?: number | undefined;
@@ -40,7 +40,7 @@ export const ReasoningPart$inboundSchema: z.ZodType<
40
40
  z.ZodTypeDef,
41
41
  unknown
42
42
  > = z.object({
43
- _id: z.string().default("reasoning_01m3jzr7dw91csc07en6byggtz"),
43
+ _id: z.string().default("reasoning_01m3m4jk9q47a15bpj6pdny63w"),
44
44
  metadata: z.record(z.any()).optional(),
45
45
  kind: z.literal("reasoning"),
46
46
  reasoning: z.string(),
@@ -10,7 +10,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
12
  /**
13
- * Bucket grain actually applied by the planner.
13
+ * Bucket grain actually applied. Differs from the requested value when `grain=auto`.
14
14
  */
15
15
  export const EffectiveGrain = {
16
16
  Minute: "minute",
@@ -18,7 +18,7 @@ export const EffectiveGrain = {
18
18
  Day: "day",
19
19
  } as const;
20
20
  /**
21
- * Bucket grain actually applied by the planner.
21
+ * Bucket grain actually applied. Differs from the requested value when `grain=auto`.
22
22
  */
23
23
  export type EffectiveGrain = ClosedEnum<typeof EffectiveGrain>;
24
24
 
@@ -35,7 +35,7 @@ export type Currency = ClosedEnum<typeof Currency>;
35
35
 
36
36
  export type ResponseMeta = {
37
37
  /**
38
- * Bucket grain actually applied by the planner.
38
+ * Bucket grain actually applied. Differs from the requested value when `grain=auto`.
39
39
  */
40
40
  effectiveGrain?: EffectiveGrain | undefined;
41
41
  /**
@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
  import { RerankConfig, RerankConfig$inboundSchema } from "./rerankconfig.js";
11
11
 
12
- export type InternalRetrievalConfig = {
12
+ export type RetrievalConfig = {
13
13
  type?: string | undefined;
14
14
  topK?: number | undefined;
15
15
  threshold?: number | undefined;
@@ -17,8 +17,8 @@ export type InternalRetrievalConfig = {
17
17
  };
18
18
 
19
19
  /** @internal */
20
- export const InternalRetrievalConfig$inboundSchema: z.ZodType<
21
- InternalRetrievalConfig,
20
+ export const RetrievalConfig$inboundSchema: z.ZodType<
21
+ RetrievalConfig,
22
22
  z.ZodTypeDef,
23
23
  unknown
24
24
  > = z.object({
@@ -33,12 +33,12 @@ export const InternalRetrievalConfig$inboundSchema: z.ZodType<
33
33
  });
34
34
  });
35
35
 
36
- export function internalRetrievalConfigFromJSON(
36
+ export function retrievalConfigFromJSON(
37
37
  jsonString: string,
38
- ): SafeParseResult<InternalRetrievalConfig, SDKValidationError> {
38
+ ): SafeParseResult<RetrievalConfig, SDKValidationError> {
39
39
  return safeParse(
40
40
  jsonString,
41
- (x) => InternalRetrievalConfig$inboundSchema.parse(JSON.parse(x)),
42
- `Failed to parse 'InternalRetrievalConfig' from JSON`,
41
+ (x) => RetrievalConfig$inboundSchema.parse(JSON.parse(x)),
42
+ `Failed to parse 'RetrievalConfig' from JSON`,
43
43
  );
44
44
  }
@@ -308,7 +308,7 @@ export type FilterBy1 =
308
308
  | Exists;
309
309
 
310
310
  /**
311
- * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information.
311
+ * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
312
312
  */
313
313
  export type FilterBy =
314
314
  | SearchKnowledgeRequestFilterByAnd
@@ -328,7 +328,7 @@ export type FilterBy =
328
328
 
329
329
  export type Two = {
330
330
  /**
331
- * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models).
331
+ * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#chat-models).
332
332
  */
333
333
  model?: string | undefined;
334
334
  /**
@@ -347,7 +347,7 @@ export type Two = {
347
347
 
348
348
  export type AgenticRagConfig1 = {
349
349
  /**
350
- * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models).
350
+ * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#chat-models).
351
351
  */
352
352
  model: string;
353
353
  /**
@@ -390,7 +390,7 @@ export type SearchKnowledgeRequest = {
390
390
  threshold?: number | undefined;
391
391
  searchType?: SearchType | undefined;
392
392
  /**
393
- * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information.
393
+ * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
394
394
  */
395
395
  filterBy?:
396
396
  | SearchKnowledgeRequestFilterByAnd
@@ -26,10 +26,10 @@ export type SearchLogsResponse = {
26
26
  nextPageToken?: string | undefined;
27
27
  meta?: TraceSearchMeta | undefined;
28
28
  /**
29
- * Exact match count for the full time range (cursor-independent, constant
29
+ * Exact match count for the full time range. Constant across pages.
30
30
  *
31
31
  * @remarks
32
- * across pages). int64 serializes as a JSON string per protojson.
32
+ * Serialized as a JSON string.
33
33
  */
34
34
  totalCount?: string | undefined;
35
35
  };
@@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
 
8
8
  export type SearchRerankConfig = {
9
9
  /**
10
- * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models).
10
+ * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#rerank-models).
11
11
  */
12
12
  model: string;
13
13
  /**
@@ -39,7 +39,7 @@ export type Sharing = {
39
39
  * Consuming projects may pin a specific version instead of tracking
40
40
  *
41
41
  * @remarks
42
- * latest. Enforcement lives with the consuming reference.
42
+ * the latest version.
43
43
  */
44
44
  allowVersionPin?: boolean | undefined;
45
45
  /**
@@ -53,8 +53,7 @@ export type Sharing = {
53
53
  * New projects created after this sharing config is applied should
54
54
  *
55
55
  * @remarks
56
- * receive access automatically. Enforcement lives with project
57
- * creation and entity-specific adoption code.
56
+ * receive access automatically.
58
57
  */
59
58
  autoGrantNewProjects?: boolean | undefined;
60
59
  };
@@ -2403,7 +2403,7 @@ export type CreateAgentRequestFallbackModelConfiguration =
2403
2403
 
2404
2404
  export type Model = {
2405
2405
  /**
2406
- * The database ID of the primary model
2406
+ * ID of the primary model, in provider/model-id format (for example `openai/gpt-5.6-sol`)
2407
2407
  */
2408
2408
  id: string;
2409
2409
  /**
@@ -1247,7 +1247,7 @@ export type FilterBy1 =
1247
1247
  | CreateChatCompletion1Nin;
1248
1248
 
1249
1249
  /**
1250
- * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
1250
+ * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
1251
1251
  */
1252
1252
  export type FilterBy = FilterByAnd | FilterByOr | {
1253
1253
  [k: string]:
@@ -1284,7 +1284,7 @@ export type SearchOptions = {
1284
1284
  */
1285
1285
  export type RerankConfig = {
1286
1286
  /**
1287
- * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#rerank-models).
1287
+ * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#rerank-models).
1288
1288
  */
1289
1289
  model: string;
1290
1290
  /**
@@ -1302,7 +1302,7 @@ export type RerankConfig = {
1302
1302
  */
1303
1303
  export type AgenticRagConfig = {
1304
1304
  /**
1305
- * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#chat-models).
1305
+ * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#chat-models).
1306
1306
  */
1307
1307
  model: string;
1308
1308
  };
@@ -1321,7 +1321,7 @@ export type CreateChatCompletionKnowledgeBases = {
1321
1321
  */
1322
1322
  searchType?: SearchType | null | undefined;
1323
1323
  /**
1324
- * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
1324
+ * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
1325
1325
  */
1326
1326
  filterBy?: FilterByAnd | FilterByOr | {
1327
1327
  [k: string]:
@@ -1467,7 +1467,7 @@ export type CreateChatCompletionRequestBody = {
1467
1467
  | CreateChatCompletionMessagesToolMessage
1468
1468
  >;
1469
1469
  /**
1470
- * Model ID used to generate the response, like `openai/gpt-5.6-sol` or `anthropic/claude-sonnet-5`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [Supported models](/docs/ai-gateway/supported-models) to browse available models.
1470
+ * Model ID used to generate the response, like `openai/gpt-5.6-sol` or `anthropic/claude-sonnet-5`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [Supported models](/ai-gateway/supported-models) to browse available models.
1471
1471
  */
1472
1472
  model: string;
1473
1473
  /**
@@ -470,7 +470,7 @@ export type CreateCompletionFilterBy1 =
470
470
  | CreateCompletion1Nin;
471
471
 
472
472
  /**
473
- * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
473
+ * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
474
474
  */
475
475
  export type CreateCompletionFilterBy =
476
476
  | CreateCompletionFilterByAnd
@@ -510,7 +510,7 @@ export type CreateCompletionSearchOptions = {
510
510
  */
511
511
  export type CreateCompletionRerankConfig = {
512
512
  /**
513
- * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#rerank-models).
513
+ * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#rerank-models).
514
514
  */
515
515
  model: string;
516
516
  /**
@@ -528,7 +528,7 @@ export type CreateCompletionRerankConfig = {
528
528
  */
529
529
  export type CreateCompletionAgenticRagConfig = {
530
530
  /**
531
- * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#chat-models).
531
+ * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#chat-models).
532
532
  */
533
533
  model: string;
534
534
  };
@@ -547,7 +547,7 @@ export type CreateCompletionKnowledgeBases = {
547
547
  */
548
548
  searchType?: CreateCompletionSearchType | null | undefined;
549
549
  /**
550
- * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
550
+ * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
551
551
  */
552
552
  filterBy?: CreateCompletionFilterByAnd | CreateCompletionFilterByOr | {
553
553
  [k: string]:
@@ -281,7 +281,7 @@ export type CreateImageOrq = {
281
281
  };
282
282
 
283
283
  /**
284
- * input
284
+ * The image generation request: the prompt plus optional size, quality, style and format settings.
285
285
  */
286
286
  export type CreateImageRequestBody = {
287
287
  /**
@@ -266,7 +266,7 @@ export type CreateImageEditOrq = {
266
266
 
267
267
  export type CreateImageEditRequestBody = {
268
268
  /**
269
- * The model to use for image edit. [Check models](https://docs.orq.ai/docs/ai-gateway/supported-models#image-models)
269
+ * The model to use for image edit. [Check models](https://docs.orq.ai/ai-gateway/supported-models#image-models)
270
270
  */
271
271
  model: string;
272
272
  /**
@@ -810,7 +810,7 @@ export type PromptInput = {
810
810
  | CreatePromptMessagesToolMessage
811
811
  >;
812
812
  /**
813
- * Model ID used to generate the response, like `openai/gpt-5.6-sol` or `anthropic/claude-sonnet-5`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway/supported-models. Only chat models are supported.
813
+ * Model ID used to generate the response, like `openai/gpt-5.6-sol` or `anthropic/claude-sonnet-5`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/ai-gateway/supported-models. Only chat models are supported.
814
814
  */
815
815
  model?: string | undefined;
816
816
  /**
@@ -1575,7 +1575,7 @@ export const ResponseBodyCodeExecutionTool$inboundSchema: z.ZodType<
1575
1575
  z.ZodTypeDef,
1576
1576
  unknown
1577
1577
  > = z.object({
1578
- _id: z.string().default("tool_01M3JZR7HGBA72T3GJFCG5P9FD"),
1578
+ _id: z.string().default("tool_01M3M4JKE3ZS1WGQVMEDSZP26W"),
1579
1579
  path: z.string(),
1580
1580
  key: z.string(),
1581
1581
  display_name: z.string().optional(),
@@ -1761,7 +1761,7 @@ export const ResponseBodyHTTPTool$inboundSchema: z.ZodType<
1761
1761
  z.ZodTypeDef,
1762
1762
  unknown
1763
1763
  > = z.object({
1764
- _id: z.string().default("tool_01M3JZR7HGEDWCC6S3R401RD7B"),
1764
+ _id: z.string().default("tool_01M3M4JKE2A12ZHFRVVD29PN8P"),
1765
1765
  path: z.string(),
1766
1766
  key: z.string(),
1767
1767
  display_name: z.string().optional(),
@@ -1854,7 +1854,7 @@ export const ResponseBodyJSONSchemaTool$inboundSchema: z.ZodType<
1854
1854
  z.ZodTypeDef,
1855
1855
  unknown
1856
1856
  > = z.object({
1857
- _id: z.string().default("tool_01M3JZR7HF5WACA4P41JQBDKN3"),
1857
+ _id: z.string().default("tool_01M3M4JKE1D65RJEQV17Z8Q5Q9"),
1858
1858
  path: z.string(),
1859
1859
  key: z.string(),
1860
1860
  display_name: z.string().optional(),
@@ -1955,7 +1955,7 @@ export const ResponseBodyFunctionTool$inboundSchema: z.ZodType<
1955
1955
  z.ZodTypeDef,
1956
1956
  unknown
1957
1957
  > = z.object({
1958
- _id: z.string().default("tool_01M3JZR7HF8RBWK1XX1WHZ0JXR"),
1958
+ _id: z.string().default("tool_01M3M4JKE1Y8R8984VPC7JKTPS"),
1959
1959
  path: z.string(),
1960
1960
  key: z.string(),
1961
1961
  display_name: z.string().optional(),
@@ -639,7 +639,7 @@ export const DataCodeExecutionTool$inboundSchema: z.ZodType<
639
639
  z.ZodTypeDef,
640
640
  unknown
641
641
  > = z.object({
642
- _id: z.string().default("tool_01M3JZR7HCHJ901WH01ZJCZ7F6"),
642
+ _id: z.string().default("tool_01M3M4JKDWCJ5N69M7K8M4JHMG"),
643
643
  path: z.string(),
644
644
  key: z.string(),
645
645
  display_name: z.string().optional(),
@@ -821,7 +821,7 @@ export const DataHTTPTool$inboundSchema: z.ZodType<
821
821
  z.ZodTypeDef,
822
822
  unknown
823
823
  > = z.object({
824
- _id: z.string().default("tool_01M3JZR7HB731K9GHF0C730W5J"),
824
+ _id: z.string().default("tool_01M3M4JKDVKMGHFF65Z0D6MXKW"),
825
825
  path: z.string(),
826
826
  key: z.string(),
827
827
  display_name: z.string().optional(),
@@ -914,7 +914,7 @@ export const DataJSONSchemaTool$inboundSchema: z.ZodType<
914
914
  z.ZodTypeDef,
915
915
  unknown
916
916
  > = z.object({
917
- _id: z.string().default("tool_01M3JZR7HAA1Z01SDZ4BE44PW3"),
917
+ _id: z.string().default("tool_01M3M4JKDV4CSA9SQ9T1KVNKVN"),
918
918
  path: z.string(),
919
919
  key: z.string(),
920
920
  display_name: z.string().optional(),
@@ -1012,7 +1012,7 @@ export const DataFunctionTool$inboundSchema: z.ZodType<
1012
1012
  z.ZodTypeDef,
1013
1013
  unknown
1014
1014
  > = z.object({
1015
- _id: z.string().default("tool_01M3JZR7HA8DBB0EV3PV5YN5GB"),
1015
+ _id: z.string().default("tool_01M3M4JKDTKGX22DZDHFR019BW"),
1016
1016
  path: z.string(),
1017
1017
  key: z.string(),
1018
1018
  display_name: z.string().optional(),
@@ -140,7 +140,7 @@ export const GetV2HumanEvalSetsResponseBody2$inboundSchema: z.ZodType<
140
140
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
141
141
  .optional(),
142
142
  updated: z.string().datetime({ offset: true }).default(
143
- "2026-09-28T03:08:13.715Z",
143
+ "2026-09-28T13:51:44.542Z",
144
144
  ).transform(v => new Date(v)),
145
145
  filter_type: z.literal("name"),
146
146
  filter_value: z.string(),
@@ -185,7 +185,7 @@ export const GetV2HumanEvalSetsResponseBody1$inboundSchema: z.ZodType<
185
185
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
186
186
  .optional(),
187
187
  updated: z.string().datetime({ offset: true }).default(
188
- "2026-09-28T03:08:13.715Z",
188
+ "2026-09-28T13:51:44.542Z",
189
189
  ).transform(v => new Date(v)),
190
190
  filter_type: z.literal("span_type"),
191
191
  filter_values: z.array(z.string()),
@@ -141,7 +141,7 @@ export const GetV2HumanEvalSetsIdResponseBody2$inboundSchema: z.ZodType<
141
141
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
142
142
  .optional(),
143
143
  updated: z.string().datetime({ offset: true }).default(
144
- "2026-09-28T03:08:13.715Z",
144
+ "2026-09-28T13:51:44.542Z",
145
145
  ).transform(v => new Date(v)),
146
146
  filter_type: z.literal("name"),
147
147
  filter_value: z.string(),
@@ -186,7 +186,7 @@ export const GetV2HumanEvalSetsIdResponseBody1$inboundSchema: z.ZodType<
186
186
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
187
187
  .optional(),
188
188
  updated: z.string().datetime({ offset: true }).default(
189
- "2026-09-28T03:08:13.715Z",
189
+ "2026-09-28T13:51:44.542Z",
190
190
  ).transform(v => new Date(v)),
191
191
  filter_type: z.literal("span_type"),
192
192
  filter_values: z.array(z.string()),
@@ -1228,7 +1228,7 @@ export type ListAgentsFallbackModelConfiguration =
1228
1228
 
1229
1229
  export type ListAgentsModel = {
1230
1230
  /**
1231
- * The database ID of the primary model
1231
+ * ID of the primary model, in provider/model-id format (for example `openai/gpt-5.6-sol`)
1232
1232
  */
1233
1233
  id: string;
1234
1234
  /**
@@ -51,7 +51,7 @@ export type LateChunkerStrategy = {
51
51
  */
52
52
  minCharactersPerChunk?: number | undefined;
53
53
  /**
54
- * Embedding model used to generate context-aware chunk embeddings. [Available embedding models](/docs/ai-gateway/supported-models#embedding-models)
54
+ * Embedding model used to generate context-aware chunk embeddings. [Available embedding models](/ai-gateway/supported-models#embedding-models)
55
55
  */
56
56
  embeddingModel: string;
57
57
  /**
@@ -154,7 +154,7 @@ export type AgenticChunkerStrategy = {
154
154
  returnType?: ParseChunkingRequestChunkingRequestReturnType | undefined;
155
155
  strategy: "agentic";
156
156
  /**
157
- * Model to use for chunking. [Available models](/docs/ai-gateway/supported-models#chat-models)
157
+ * Model to use for chunking. [Available models](/ai-gateway/supported-models#chat-models)
158
158
  */
159
159
  model: string;
160
160
  /**
@@ -237,7 +237,7 @@ export type SemanticChunkerStrategy = {
237
237
  */
238
238
  threshold?: number | Threshold2 | undefined;
239
239
  /**
240
- * Embedding model to use for semantic similarity. [Available embedding models](/docs/ai-gateway/supported-models#embedding-models)
240
+ * Embedding model to use for semantic similarity. [Available embedding models](/ai-gateway/supported-models#embedding-models)
241
241
  */
242
242
  embeddingModel: string;
243
243
  /**
@@ -318,7 +318,7 @@ export const PatchV2HumanEvalSetsIdResponseBody2$inboundSchema: z.ZodType<
318
318
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
319
319
  .optional(),
320
320
  updated: z.string().datetime({ offset: true }).default(
321
- "2026-09-28T03:08:13.715Z",
321
+ "2026-09-28T13:51:44.542Z",
322
322
  ).transform(v => new Date(v)),
323
323
  filter_type: z.literal("name"),
324
324
  filter_value: z.string(),
@@ -364,7 +364,7 @@ export const PatchV2HumanEvalSetsIdResponseBody1$inboundSchema: z.ZodType<
364
364
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
365
365
  .optional(),
366
366
  updated: z.string().datetime({ offset: true }).default(
367
- "2026-09-28T03:08:13.715Z",
367
+ "2026-09-28T13:51:44.542Z",
368
368
  ).transform(v => new Date(v)),
369
369
  filter_type: z.literal("span_type"),
370
370
  filter_values: z.array(z.string()),