Skip to content

Commit

Permalink
feat(specs): add transformation copilot to ingestion (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3479

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
  • Loading branch information
algolia-bot and Fluf22 committed Aug 6, 2024
1 parent fd44bd2 commit 01bae9f
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 0 deletions.
20 changes: 20 additions & 0 deletions src/main/scala/algoliasearch/api/IngestionClient.scala
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ import algoliasearch.ingestion.TaskV1
import algoliasearch.ingestion.Transformation
import algoliasearch.ingestion.TransformationCreate
import algoliasearch.ingestion.TransformationCreateResponse
import algoliasearch.ingestion.TransformationModels
import algoliasearch.ingestion.TransformationSearch
import algoliasearch.ingestion.TransformationTry
import algoliasearch.ingestion.TransformationTryResponse
Expand Down Expand Up @@ -1119,6 +1120,25 @@ class IngestionClient(
execute[ListTasksResponseV1](request, requestOptions)
}

/** Retrieves a list of existing LLM transformation helpers.
*
* Required API Key ACLs:
* - addObject
* - deleteIndex
* - editSettings
*/
def listTransformationModels(
requestOptions: Option[RequestOptions] = None
)(implicit ec: ExecutionContext): Future[TransformationModels] = Future {

val request = HttpRequest
.builder()
.withMethod("GET")
.withPath(s"/1/transformations/copilot")
.build()
execute[TransformationModels](request, requestOptions)
}

/** Retrieves a list of transformations.
*
* Required API Key ACLs:
Expand Down
34 changes: 34 additions & 0 deletions src/main/scala/algoliasearch/ingestion/Model.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
* to ingest your data. The Ingestion API powers the no-code [data
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package algoliasearch.ingestion

/** Model
*/
case class Model(
fullname: String,
modelName: String,
systemPrompt: String,
id: String,
provider: String
)
30 changes: 30 additions & 0 deletions src/main/scala/algoliasearch/ingestion/TransformationModels.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
* to ingest your data. The Ingestion API powers the no-code [data
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package algoliasearch.ingestion

/** List of available AI models for transformation purposes.
*/
case class TransformationModels(
llms: Seq[Model]
)

0 comments on commit 01bae9f

Please sign in to comment.