Skip to content

Commit 07c1b2e

Browse files
fix(specs): sync agent-studio OpenAPI from conversational-ai (#6967)
1 parent 26ffdd9 commit 07c1b2e

227 files changed

Lines changed: 3546 additions & 1852 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

โ€Žclients/algoliasearch-client-javascript/package.jsonโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
},
8080
{
8181
"path": "packages/agent-studio/dist/builds/browser.umd.js",
82-
"maxSize": "8.5KB"
82+
"maxSize": "9.25KB"
8383
}
8484
]
8585
},

โ€Žplayground/go/agent-studio.goโ€Ž

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,13 +99,15 @@ func testAgentStudioStreaming(appID, apiKey string) int {
9999
stream, err := client.CreateAgentCompletionStream(client.NewApiCreateAgentCompletionRequest(
100100
agent.GetId(),
101101
agentStudio.CompatibilityMode("ai-sdk-5"),
102-
agentStudio.NewEmptyAgentCompletionRequest().SetMessages(agentStudio.ArrayOfMessageV5AsMessagesUnion(
103-
[]agentStudio.MessageV5{*agentStudio.UserMessageV5AsMessageV5(
104-
agentStudio.NewEmptyUserMessageV5().SetRole("user").SetParts(
105-
[]agentStudio.TextPartV5{
106-
*agentStudio.NewEmptyTextPartV5().SetType("text").SetText("Hello, what can you do? Keep it short."),
107-
}))},
108-
)),
102+
agentStudio.AgentCompletionRequestAsAgentCompletionRequestUnion(
103+
agentStudio.NewEmptyAgentCompletionRequest().SetMessages(agentStudio.ArrayOfMessageV5AsMessagesUnion(
104+
[]agentStudio.MessageV5{*agentStudio.UserMessageV5AsMessageV5(
105+
agentStudio.NewEmptyUserMessageV5().SetRole("user").SetParts(
106+
[]agentStudio.TextPartV5{
107+
*agentStudio.NewEmptyTextPartV5().SetType("text").SetText("Hello, what can you do? Keep it short."),
108+
}))},
109+
)),
110+
),
109111
).WithStream(true))
110112
if err != nil {
111113
fmt.Printf("cannot create completion stream: %v\n", err)
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
AdvancedSyntaxFeatures:
2-
type: string
2+
description: AdvancedSyntaxFeatures.
33
enum:
4-
- exactPhrase
5-
- excludeWords
4+
- exactPhrase
5+
- excludeWords
66
title: advancedSyntaxFeatures
7-
description: AdvancedSyntaxFeatures.
7+
type: string
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
AdvancedSyntaxFeaturesUnion:
22
oneOf:
3-
- items:
4-
$ref: 'AdvancedSyntaxFeatures.yml#/AdvancedSyntaxFeatures'
5-
type: array
6-
- type: 'null'
3+
- items:
4+
$ref: AdvancedSyntaxFeatures.yml#/AdvancedSyntaxFeatures
5+
type: array
6+
- type: 'null'

โ€Žspecs/agent-studio/common/schemas/AgentCompletionAlgoliaParams.ymlโ€Ž

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,32 @@ AgentCompletionAlgoliaParams:
88
type: object
99
type: object
1010
type: object
11+
default: null
1112
title: mcpservers
1213
searchParameters:
13-
$ref: 'SearchParametersOverridesMapNullable.yml#/SearchParametersOverridesMapNullable'
14-
type: object
14+
$ref: SearchParametersOverridesMapNullable.yml#/SearchParametersOverridesMapNullable
15+
indices:
16+
items:
17+
maxLength: 100
18+
minLength: 1
19+
pattern: ^[a-zA-Z0-9_\-.]+$
20+
type: string
21+
maxItems: 10
22+
type: array
23+
default: null
24+
description: Per-request override for the Algolia Search tool's indices, honored
25+
only when the tool is configured with `mode="dynamic"`. A list of index names;
26+
the API looks up each name in the agent's static `tool.indices` and reuses
27+
that entry, including its description and access-control fields. A name the
28+
agent configuration does not list is rejected with HTTP 422 (`index_not_listed_on_tool`)
29+
unless the tool sets `allowUnlistedIndices`, in which case the API synthesizes
30+
a minimal entry carrying the index name only. Capped at 10 entries. Sending
31+
this field against an agent whose tool is in `mode="static"` (the default)
32+
is rejected with HTTP 422 โ€” change the tool's `mode` in the agent configuration
33+
first. Defaults to `null`, which preserves the existing static behavior.
34+
examples:
35+
- - docs_v9
36+
- docs_v10
37+
title: indices
1538
title: agentCompletionAlgoliaParams
39+
type: object
Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
AgentCompletionRequest:
2+
description: Request model for creating a completion for an assistant.
23
properties:
34
configuration:
4-
$ref: 'AgentTestConfiguration.yml#/AgentTestConfiguration'
5+
$ref: AgentTestConfiguration.yml#/AgentTestConfiguration
56
messages:
6-
$ref: 'MessagesUnion.yml#/MessagesUnion'
7+
$ref: MessagesUnion.yml#/MessagesUnion
78
id:
8-
type: string
99
maxLength: 128
10-
title: id
10+
type: string
11+
default: null
1112
description: Optional conversation id.
13+
title: id
1214
algolia:
13-
$ref: 'AgentCompletionAlgoliaParams.yml#/AgentCompletionAlgoliaParams'
15+
$ref: AgentCompletionAlgoliaParams.yml#/AgentCompletionAlgoliaParams
1416
toolApprovals:
1517
type: object
1618
title: toolApprovals
1719
description: Approval decisions for pending tool calls keyed by toolCallId.
18-
type: object
1920
title: agentCompletionRequest
20-
description: Request model for creating a completion for an assistant.
21+
type: object
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
AgentCompletionRequestUnion:
2+
oneOf:
3+
- $ref: AgentCompletionRequest.yml#/AgentCompletionRequest
4+
- $ref: AguiCompletionRequest.yml#/AguiCompletionRequest

โ€Žspecs/agent-studio/common/schemas/AgentConfigCreate.ymlโ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ AgentConfigCreate:
4444
features: '[memory]'
4545
tools:
4646
items:
47-
$ref: 'ToolConfigInput.yml#/ToolConfigInput'
47+
$ref: ToolConfigInput.yml#/ToolConfigInput
4848
type: array
4949
title: tools
5050
type: object
5151
required:
52-
- name
53-
- instructions
52+
- name
53+
- instructions
5454
title: agentConfigCreate

โ€Žspecs/agent-studio/common/schemas/AgentConfigUpdate.ymlโ€Ž

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@ AgentConfigUpdate:
22
properties:
33
name:
44
oneOf:
5-
- type: string
6-
- type: 'null'
5+
- type: string
6+
- type: 'null'
77
title: name
88
description:
99
oneOf:
10-
- type: string
11-
- type: 'null'
10+
- type: string
11+
- type: 'null'
1212
title: description
1313
providerId:
1414
oneOf:
15-
- type: string
16-
- type: 'null'
15+
- type: string
16+
- type: 'null'
1717
title: providerid
1818
model:
1919
oneOf:
20-
- type: string
21-
- type: 'null'
20+
- type: string
21+
- type: 'null'
2222
title: model
2323
instructions:
2424
oneOf:
25-
- type: string
26-
- type: 'null'
25+
- type: string
26+
- type: 'null'
2727
title: instructions
2828
description: 'The agent prompt: defines the agent''s role, tone, and goals.
2929
Guides how it answers using the provided context. Corresponds to the ''Agent
3030
prompt'' field in the dashboard.'
3131
systemPrompt:
3232
oneOf:
33-
- type: string
34-
- type: 'null'
33+
- type: string
34+
- type: 'null'
3535
title: systemprompt
3636
description: 'The system prompt: defines system-level rules and constraints.
3737
Guides how the agent uses tools, features, and generates context. Prepended
@@ -41,21 +41,21 @@ AgentConfigUpdate:
4141
in the dashboard.'
4242
config:
4343
oneOf:
44-
- additionalProperties: true
45-
type: object
46-
- type: 'null'
44+
- additionalProperties: true
45+
type: object
46+
- type: 'null'
4747
title: config
4848
tools:
4949
oneOf:
50-
- items:
51-
$ref: 'ToolConfigInput.yml#/ToolConfigInput'
52-
type: array
53-
- type: 'null'
50+
- items:
51+
$ref: ToolConfigInput.yml#/ToolConfigInput
52+
type: array
53+
- type: 'null'
5454
title: tools
5555
templateType:
5656
oneOf:
57-
- type: string
58-
- type: 'null'
57+
- type: string
58+
- type: 'null'
5959
title: templatetype
6060
type: object
6161
title: agentConfigUpdate

โ€Žspecs/agent-studio/common/schemas/AgentConsolidateRequest.ymlโ€Ž

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ AgentConsolidateRequest:
99
title: model
1010
description: Model name (e.g., gpt-4o-mini).
1111
messages:
12-
$ref: 'MessagesUnionAgentConsolidateRequest.yml#/MessagesUnionAgentConsolidateRequest'
12+
$ref: MessagesUnion.yml#/MessagesUnion
1313
targetMemories:
1414
type: integer
1515
maximum: 50.0
@@ -28,7 +28,7 @@ AgentConsolidateRequest:
2828
description: Wait for Algolia indexing to complete before returning.
2929
default: false
3030
memoryType:
31-
$ref: 'MemoryType.yml#/MemoryType'
31+
$ref: MemoryType.yml#/MemoryType
3232
maxExisting:
3333
type: integer
3434
maximum: 500.0
@@ -38,8 +38,8 @@ AgentConsolidateRequest:
3838
default: 50
3939
type: object
4040
required:
41-
- providerID
42-
- model
43-
- messages
41+
- providerID
42+
- model
43+
- messages
4444
title: agentConsolidateRequest
4545
description: Agent endpoint request for automatic memory consolidation.

0 commit comments

Comments
ย (0)