Skip to content

Commit 01bae9f

Browse files
algolia-botFluf22
andcommitted
feat(specs): add transformation copilot to ingestion (generated)
algolia/api-clients-automation#3479 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Thomas Raffray <[email protected]>
1 parent fd44bd2 commit 01bae9f

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

src/main/scala/algoliasearch/api/IngestionClient.scala

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ import algoliasearch.ingestion.TaskV1
6666
import algoliasearch.ingestion.Transformation
6767
import algoliasearch.ingestion.TransformationCreate
6868
import algoliasearch.ingestion.TransformationCreateResponse
69+
import algoliasearch.ingestion.TransformationModels
6970
import algoliasearch.ingestion.TransformationSearch
7071
import algoliasearch.ingestion.TransformationTry
7172
import algoliasearch.ingestion.TransformationTryResponse
@@ -1119,6 +1120,25 @@ class IngestionClient(
11191120
execute[ListTasksResponseV1](request, requestOptions)
11201121
}
11211122

1123+
/** Retrieves a list of existing LLM transformation helpers.
1124+
*
1125+
* Required API Key ACLs:
1126+
* - addObject
1127+
* - deleteIndex
1128+
* - editSettings
1129+
*/
1130+
def listTransformationModels(
1131+
requestOptions: Option[RequestOptions] = None
1132+
)(implicit ec: ExecutionContext): Future[TransformationModels] = Future {
1133+
1134+
val request = HttpRequest
1135+
.builder()
1136+
.withMethod("GET")
1137+
.withPath(s"/1/transformations/copilot")
1138+
.build()
1139+
execute[TransformationModels](request, requestOptions)
1140+
}
1141+
11221142
/** Retrieves a list of transformations.
11231143
*
11241144
* Required API Key ACLs:
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
2+
* to ingest your data. The Ingestion API powers the no-code [data
3+
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
4+
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
5+
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
6+
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
7+
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
8+
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
9+
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
10+
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
11+
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
12+
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13+
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14+
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15+
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16+
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17+
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
*
19+
* The version of the OpenAPI document: 1.0.0
20+
*
21+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
22+
* https://openapi-generator.tech Do not edit the class manually.
23+
*/
24+
package algoliasearch.ingestion
25+
26+
/** Model
27+
*/
28+
case class Model(
29+
fullname: String,
30+
modelName: String,
31+
systemPrompt: String,
32+
id: String,
33+
provider: String
34+
)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
2+
* to ingest your data. The Ingestion API powers the no-code [data
3+
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
4+
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
5+
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
6+
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
7+
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
8+
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
9+
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
10+
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
11+
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
12+
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13+
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14+
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15+
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16+
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17+
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
*
19+
* The version of the OpenAPI document: 1.0.0
20+
*
21+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
22+
* https://openapi-generator.tech Do not edit the class manually.
23+
*/
24+
package algoliasearch.ingestion
25+
26+
/** List of available AI models for transformation purposes.
27+
*/
28+
case class TransformationModels(
29+
llms: Seq[Model]
30+
)

0 commit comments

Comments
 (0)