Skip to content

Commit 52ebd28

Browse files
authored
feat(clients): release Agent Studio package updates (#6573)
1 parent 6ba85a5 commit 52ebd28

15 files changed

Lines changed: 17 additions & 84 deletions

File tree

โ€Žclients/algoliasearch-client-dart/.github/workflows/release.ymlโ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ jobs:
4747
- packages/client_search
4848
- packages/client_insights
4949
- packages/client_recommend
50+
- packages/client_ingestion
5051
- packages/client_composition
5152
- packages/client_agent_studio
5253
permissions:
@@ -56,7 +57,7 @@ jobs:
5657
working-directory: ${{ matrix.package }}
5758

5859
wait_for_dependencies:
59-
needs:
60+
needs:
6061
- check
6162
- publish_core
6263
- publish_clients
@@ -67,7 +68,7 @@ jobs:
6768
run: sleep 300
6869

6970
publish_algoliasearch:
70-
needs:
71+
needs:
7172
- check
7273
- publish_core
7374
- publish_clients

โ€Žgenerators/src/main/java/com/algolia/codegen/AlgoliaDartGenerator.javaโ€Ž

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,11 @@ public void processOpts() {
3636
additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
3737
additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
3838

39-
// Use a beta version for the agent-studio standalone package
40-
String effectiveVersion = version;
41-
if (client.equals("agent-studio")) {
42-
effectiveVersion = "0.1.0-beta.0";
43-
}
44-
4539
// pubspec.yaml
4640
setPubAuthor("Algolia");
4741
setPubAuthorEmail("hey@algolia.com");
4842
setPubHomepage("https://www.algolia.com/doc/");
49-
setPubVersion(effectiveVersion);
43+
setPubVersion(version);
5044
String packageFolder;
5145
if (isAlgoliasearchClient) {
5246
libName = "algoliasearch";
@@ -113,7 +107,7 @@ public void processOpts() {
113107

114108
// Search config
115109
additionalProperties.put("isSearchClient", client.equals("search"));
116-
additionalProperties.put("packageVersion", effectiveVersion);
110+
additionalProperties.put("packageVersion", version);
117111

118112
// Only clients shipping hand-authored helpers export `src/extension.dart`.
119113
additionalProperties.put("hasExtensions", client.equals("search") || isAlgoliasearchClient);

โ€Žgenerators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.javaโ€Ž

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,6 @@ private void setDefaultGeneratorOptions() {
158158
additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient);
159159
additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
160160
additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName));
161-
// Use a beta version for the agent-studio standalone package
162-
if (CLIENT.equals("agentStudio")) {
163-
additionalProperties.put("packageVersion", "0.1.0-beta.0");
164-
}
165161
additionalProperties.put("packageName", packageName);
166162
additionalProperties.put("npmPackageName", isAlgoliasearchClient ? packageName : "@algolia/" + packageName);
167163
additionalProperties.put("searchHelpers", CLIENT.equals("search"));

โ€Žspecs/agent-studio/spec.ymlโ€Ž

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ info:
66
77
Use it to create, configure, publish, and update agents, then generate chat completions grounded in live data from your Algolia indices. You can manage LLM providers, Agent Studio tools, conversations, feedback, secret keys, user data, caching, and application settings for your AI experiences.
88
9-
## Beta
10-
11-
The Agent Studio API is a **beta feature** according to [Algolia's Terms of Service ("Beta Services")](https://www.algolia.com/policies/terms/).
12-
139
## Client libraries
1410
1511
Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.
@@ -49,7 +45,6 @@ info:
4945
5046
The current version of the Agent Studio API is version 1, indicated by the `/1/` in each endpoint's URL.
5147
version: 0.1.0
52-
x-beta: true
5348
components:
5449
securitySchemes:
5550
appId:
@@ -87,6 +82,7 @@ tags:
8782
description: Manage secret keys used to authenticate requests.
8883
- name: User Data
8984
description: Manage end-user data associated with conversations.
85+
x-beta: true
9086
x-timeouts:
9187
browser:
9288
connect: 25000

โ€Žtemplates/csharp/api.mustacheโ€Ž

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,6 @@ namespace Algolia.Search.Clients;
128128
/// <summary>
129129
/// Represents a collection of functions to interact with the API endpoints
130130
/// </summary>
131-
{{#isAgentStudioClient}}
132-
[System.Obsolete("Agent Studio API is in beta and subject to breaking changes. See https://www.algolia.com/doc/rest-api/agent-studio", false)]
133-
{{/isAgentStudioClient}}
134131
{{> visibility}} partial class {{classname}} : {{interfacePrefix}}{{classname}}, IDisposable
135132
{
136133
internal HttpTransport _transport;
@@ -351,7 +348,7 @@ namespace Algolia.Search.Clients;
351348
return client;
352349
}
353350
{{/isSearchClient}}
354-
351+
355352

356353
{{#operation}}
357354
{{#supportsAsync}}

โ€Žtemplates/dart/api.mustacheโ€Ž

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@ import 'package:algolia_client_ingestion/algolia_client_ingestion.dart' as inges
1414
{{#description}}
1515
/// {{{description}}}
1616
{{/description}}
17-
{{#isAgentStudioClient}}
18-
/// **Beta:** The Agent Studio API is not yet stable and may change without notice.
19-
/// See https://www.algolia.com/doc/rest-api/agent-studio
20-
{{/isAgentStudioClient}}
2117
final class {{classname}} implements ApiClient {
2218
2319
@override
@@ -87,7 +83,7 @@ final class {{classname}} implements ApiClient {
8783
{{/fallbackToAliasHost}}
8884
final url = {{#fallbackToAliasHost}}region == null ? '{{{hostWithFallback}}}' : {{/fallbackToAliasHost}} '{{{regionalHost}}}'.replaceAll('{region}', region);
8985
return [Host(url: url)];
90-
}
86+
}
9187
{{/hasRegionalHost}}
9288
{{#uniqueHost}}
9389
{{/uniqueHost}}
@@ -221,7 +217,7 @@ final class {{classname}} implements ApiClient {
221217
{{#hasBodyParam}}
222218
body: {{#bodyParam}}{{{paramName}}}{{#isModel}}{{^isRequired}}?{{/isRequired}}.toJson(){{/isModel}},{{/bodyParam}}
223219
{{/hasBodyParam}}
224-
);
220+
);
225221
{{#returnType}}final response = {{/returnType}}await _retryStrategy.execute(
226222
request: request,
227223
options: {{#vendorExtensions.x-timeouts}}RequestOptions(
@@ -236,7 +232,7 @@ final class {{classname}} implements ApiClient {
236232
{{/vendorExtensions.x-is-custom-request}}
237233
return deserialize<{{{.}}}, {{{returnBaseType}}}>(response, '{{{.}}}', growable: true,);
238234
{{/returnType}}
239-
}
235+
}
240236
{{/operation}}
241237

242238
{{^isCompositionClient}}

โ€Žtemplates/go/client.mustacheโ€Ž

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,6 @@ import (
2525

2626
// APIClient manages communication with the {{appName}} API v{{version}}
2727
// In most cases there should be only one, shared, APIClient.
28-
{{#isAgentStudioClient}}
29-
//
30-
// Beta: The Agent Studio API is not yet stable and may change without notice.
31-
// See: https://www.algolia.com/doc/rest-api/agent-studio
32-
{{/isAgentStudioClient}}
3328
type APIClient struct {
3429
appID string
3530
cfg *{{#lambda.titlecase}}{{#lambda.camelcase}}{{client}}{{/lambda.camelcase}}{{/lambda.titlecase}}Configuration
@@ -295,7 +290,7 @@ func (c *APIClient) prepareRequest(
295290
}
296291

297292
contentType := "application/json"
298-
293+
299294
// Add the user agent to the request.
300295
req.Header.Add("User-Agent", c.cfg.UserAgent)
301296
req.Header.Add("X-Algolia-Application-Id", c.cfg.AppID)

โ€Žtemplates/java/api.mustacheโ€Ž

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,6 @@ import javax.crypto.spec.SecretKeySpec;
6161
{{/isAgentStudioClient}}
6262

6363
{{#operations}}
64-
{{#isAgentStudioClient}}
65-
/**
66-
* Beta: The Agent Studio API is not yet stable and may introduce breaking changes.
67-
* @see <a href="https://www.algolia.com/doc/rest-api/agent-studio">Agent Studio API docs</a>
68-
*/
69-
{{/isAgentStudioClient}}
7064
public class {{classname}} extends ApiClient {
7165
{{#isSearchClient}}
7266
private IngestionClient ingestionTransporter;
@@ -130,7 +124,7 @@ public class {{classname}} extends ApiClient {
130124
public {{classname}}(String appId, String apiKey, String region, ClientOptions options) {
131125
super(appId, apiKey, "{{{baseName}}}", options, getDefaultHosts(region), Duration.ofMillis({{{x-timeouts.server.connect}}}L), Duration.ofMillis({{{x-timeouts.server.read}}}L), Duration.ofMillis({{{x-timeouts.server.write}}}L));
132126
}
133-
127+
134128
{{/hasRegionalHost}}
135129
{{^hasRegionalHost}}
136130
public {{classname}}(String appId, String apiKey) {
@@ -220,7 +214,7 @@ public class {{classname}} extends ApiClient {
220214
return hosts;
221215
}
222216
{{/hasRegionalHost}}
223-
217+
224218
{{#hostsWithoutVariables.size}}
225219
private static List<Host> getDefaultHosts() {
226220
List<Host> hosts = new ArrayList<>();
@@ -344,7 +338,7 @@ public class {{classname}} extends ApiClient {
344338
.setMethod("{{httpMethod}}")
345339
{{#bodyParam}}.setBody({{paramName}}){{/bodyParam}}
346340
{{#vendorExtensions.x-use-read-transporter}}.setRead(true){{/vendorExtensions.x-use-read-transporter}}
347-
{{#headerParams}}.addHeader("{{baseName}}", {{paramName}}){{/headerParams}}
341+
{{#headerParams}}.addHeader("{{baseName}}", {{paramName}}){{/headerParams}}
348342
{{#vendorExtensions}}{{#queryParams}}{{^x-is-custom-request}}.addQueryParameter("{{baseName}}", {{paramName}}){{/x-is-custom-request}}{{#x-is-custom-request}}.addQueryParameters(parameters){{/x-is-custom-request}}{{/queryParams}}{{/vendorExtensions}}
349343
.build();
350344
return executeAsync(request, {{#vendorExtensions.x-timeouts}}new RequestOptions().setReadTimeout(Duration.ofMillis({{{read}}}L)).setWriteTimeout(Duration.ofMillis({{{write}}}L)).setConnectTimeout(Duration.ofMillis({{{connect}}}L)).mergeRight({{/vendorExtensions.x-timeouts}}requestOptions{{#vendorExtensions.x-timeouts}}){{/vendorExtensions.x-timeouts}}, {{#vendorExtensions}}{{#x-is-generic}}{{{returnType}}}.class, innerType{{/x-is-generic}}{{/vendorExtensions}}{{^vendorExtensions.x-is-generic}}{{^returnType}}null{{/returnType}}{{#returnType}}new TypeReference<{{{.}}}>(){}{{/returnType}}{{/vendorExtensions.x-is-generic}});

โ€Žtemplates/javascript/clients/api-single.mustacheโ€Ž

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,6 @@ export const apiClientVersion = '{{packageVersion}}';
1111
{{> client/api/guards}}
1212
{{/isIngestionClient}}
1313

14-
{{#isAgentStudioClient}}
15-
/**
16-
* @beta
17-
* The Agent Studio API is not yet stable and may change without notice.
18-
* See {@link https://www.algolia.com/doc/rest-api/agent-studio | Agent Studio API docs}.
19-
*/
20-
{{/isAgentStudioClient}}
2114
export function create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
2215
appId: appIdOption,
2316
apiKey: apiKeyOption,

โ€Žtemplates/kotlin/api.mustacheโ€Ž

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@ import {{modelPackage}}.RequestBody
1515
{{/isCompositionClient}}
1616

1717
{{#operations}}
18-
{{#isAgentStudioClient}}
19-
/**
20-
* Beta: The Agent Studio API is not yet stable and may change without notice.
21-
* @see [Agent Studio API docs](https://www.algolia.com/doc/rest-api/agent-studio)
22-
*/
23-
{{/isAgentStudioClient}}
2418
public class {{classname}}(
2519
override val appId: String,
2620
override var apiKey: String,

0 commit comments

Comments
ย (0)