[REST] New AI endpoints#2605

Merged

mnocon merged 9 commits intomasterfrom

Mar 5, 2025

Contributor

mnocon commented Feb 6, 2025 •

edited

Loading

Doc for endpoints introduced in:

Preview

Questions:

The GET /ai/actions and POST /ai/actions return the same data - I wasn't sure how to name these entries, I've chosen:

List action configurations
List action configurations (POST)

but maybe there's something better

mnocon added the Needs DEV review label

mnocon requested review from adriendupuis and barw4

February 6, 2025 12:12

barw4 requested changes

View reviewed changes

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml Outdated Show resolved Hide resolved

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml Outdated Show resolved Hide resolved

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml Outdated Show resolved Hide resolved

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml Outdated Show resolved Hide resolved

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml Show resolved Hide resolved

...est_api/rest_api_reference/input/examples/ai/actions/GET/ActionConfigurationList.xml.example Outdated Show resolved Hide resolved

...st_api/rest_api_reference/input/examples/ai/actions/GET/ActionConfigurationList.json.example Show resolved Hide resolved

...pi/rest_api/rest_api_reference/input/examples/ai/actions/GET/ActionConfiguration.xml.example Show resolved Hide resolved

...i/rest_api/rest_api_reference/input/examples/ai/actions/GET/ActionConfiguration.json.example Show resolved Hide resolved

docs/api/rest_api/rest_api_reference/input/ibexa-ai.raml Outdated Show resolved Hide resolved

github-actions bot commented Feb 13, 2025

Preview of modified Markdown: no Markdown change to preview.

Contributor Author

mnocon commented Feb 13, 2025

@barw4 thank you for the review, I've applied the types changes in #2605 and the ActionConfiguration responses are regenerated in 4864e0d

mnocon requested a review from barw4

February 13, 2025 15:04

barw4 approved these changes

View reviewed changes

mnocon added Needs DOC review and removed Needs DEV review labels

mnocon requested review from dabrt, julitafalcondusza and juskora

February 18, 2025 14:51

dabrt approved these changes

View reviewed changes

Contributor

dabrt left a comment

Please see my comments.

docs/api/rest_api/rest_api_reference/input/ibexa-ai.raml

    
            @@ -1,5 +1,5 @@
          
              displayName: AI Actions

              /execute/{actionConfiguration}:

              displayName: AI actions

This comment was marked as resolved.

Sign in to view

Contributor Author

mnocon Feb 25, 2025

(Answered in DM - the short answer is that the old route still works)

docs/api/rest_api/rest_api_reference/input/ibexa-ai.raml Outdated

+              /actions:
+                  get:
+                      displayName: List action configurations
+                      description: Returns a list of action configurations

Contributor

dabrt Feb 25, 2025

Suggested change

      
                    description: Returns a list of action configurations
          
                    description: Returns a list of action configurations.

docs/api/rest_api/rest_api_reference/input/ibexa-ai.raml Outdated

+                      description: Returns a list of action configurations
+                      queryParameters:
+                          limit:
+                              description: The number of results per page

Contributor

dabrt Feb 25, 2025

Seems like we are inconsistent in putting fullstops at the end of query paramater descriptions, but the ones with fullstop largely prevail.
I'd add fullstops then, even though these are not full sentences. Alternatively, we'd want to go through all descriptions and amend them to have fullstops in sentences and no fullstops in nominal sentence fragments

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml

                                           type: string
                                       text:
                                           type: string[]
+              ActionTypeListWrapper:

Contributor

dabrt Feb 25, 2025 •

edited

Loading

Again, we are inconsistent in providing descriptions for objects and for object properties. For close to 2 thousand elements that could have a description key (objects and properties), there is a little over a thousand descriptions.
What's the convention?

julitafalcondusza approved these changes

View reviewed changes

Contributor Author

mnocon commented Feb 27, 2025

@julitafalcondusza @dabrt full stops and descriptions added in:

b7b96bf (full stops)
4e0f77a (descriptions)
9b8df8a regenerates the reference

dabrt approved these changes

View reviewed changes

Contributor

dabrt left a comment

Please see my comments

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                                           </a>
                                       </td>
-                                      <td></td>
+                                      <td>JSON object with only RefineText property.</td>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                                    <td>JSON object with only RefineText property.</td>
          
                                    <td>JSON object with only the RefineText property.</td>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                                           </a>
                                       </td>
-                                      <td></td>
+                                      <td>JSON object with only a GenerateAltText property.</td>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                                    <td>JSON object with only a GenerateAltText property.</td>
          
                                    <td>JSON object with only the GenerateAltText property.</td>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                                           </a>
                                       </td>
-                                      <td></td>
+                                      <td>JSON object with only AltText property.</td>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                                    <td>JSON object with only AltText property.</td>
          
                                    <td>JSON object with only the AltText property.</td>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                                           </a>
                                       </td>
-                                      <td></td>
+                                      <td>JSON object with only RefineText property.</td>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                                    <td>JSON object with only RefineText property.</td>
          
                                    <td>JSON object with only the RefineText property.</td>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                                           </a>
                                       </td>
-                                      <td></td>
+                                      <td>JSON object with only ActionTypeList property.</td>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                                    <td>JSON object with only ActionTypeList property.</td>
          
                                    <td>JSON object with only the ActionTypeList property.</td>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                -
               <span>
-                  </span>
+                  JSON object with only RefineText property.</span>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                JSON object with only RefineText property.</span>
          
                JSON object with only the RefineText property.</span>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                -
               <span>
-                  </span>
+                  JSON object with only RefineText property.</span>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                JSON object with only RefineText property.</span>
          
                JSON object with only the RefineText property.</span>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                -
               <span>
-                  </span>
+                  JSON object with only AltText property.</span>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                JSON object with only AltText property.</span>
          
                JSON object with only the AltText property.</span>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                -
               <span>
-                  </span>
+                  JSON object with only ActionTypeList property.</span>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                JSON object with only ActionTypeList property.</span>
          
                JSON object with only the ActionTypeList property.</span>

docs/api/rest_api/rest_api_reference/rest_api_reference.html Outdated

                -
               <span>
-                  </span>
+                  Object describing the criteria used to search for Action Conigurations.</span>

Contributor

dabrt Mar 4, 2025

Suggested change

      
                Object describing the criteria used to search for Action Conigurations.</span>
          
                Object describing the criteria used to search for Action Configurations.</span>

mnocon added 9 commits

March 5, 2025 09:25


          [REST] New AI endpoints

073ad6e


          Review fixes - part 1

9f8e860


          Regenerated responses

c581082


          Rebuild the reference

2ef0e04


          Added fullstops.

f3e972a


          Added descriptions

580a1f3


          Regemerated the reference

d558aa7


          Description fixes

03d234e


          Regenerated the reference

c50f0b7

mnocon force-pushed the ai-rest branch from 1c6df63 to c50f0b7 Compare

March 5, 2025 08:27

mnocon merged commit 91cec13 into master

7 checks passed

mnocon deleted the ai-rest branch

March 5, 2025 09:51

mnocon added a commit that referenced this pull request


          [REST] New AI endpoints (#2605)

7cfa9fb

* [REST] New AI endpoints

* Review fixes - part 1

* Regenerated responses

* Rebuild the reference

* Added fullstops.

* Added descriptions

* Regemerated the reference

* Description fixes

* Regenerated the reference

mnocon mentioned this pull request

New in doc: February 2025 #2660

Merged

mnocon mentioned this pull request

[4.6] Doc for Elasticsearch 8 #3022

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs DOC review