[DOC-13706] USING AI Limitations #470

rakhi-prathap · 2025-11-07T11:00:50Z

This PR addresses the current limitations of the USING AI statement on Couchbase Capella, and also, fixes a few broken links.

Docs preview: USING AI
Preview credentials: Credentials for internal review

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

GauravJayaraj

Hmm. I think that's fair. But I also think we should let the users know that it would log them out. We don't have to go into the details of why this happens.

We should also mention that the feature cannot be used by SSO, Social & MFA users.

@rijuCB Can you please let us know of any other limitations that we may have missed? Thanks.

rijuCB

We should mention that it only works with certain account types.
It might be worth raising a tiket to disable the USING AI feature being invoked via Capella.

GauravJayaraj · 2025-11-11T05:13:34Z

We should mention that it only works with certain account types.

Ack.

It might be worth raising a tiket to disable the USING AI feature being invoked via Capella.

Yep, will give this some thought and raise a ticket if it would help fix the issue.

@rakhi-prathap I agree with the idea of leaving out the specifics so users don't try it on the Capella UI. Can you incorporate the feedback from Riju - that it wouldn't work for users signed in through SSO, Socials or MFA.
Thanks

GauravJayaraj

Approved! Thanks.
(I don't think the preview site has picked up the lastest commit that applies the review feedback.)

rakhi-prathap · 2025-11-12T09:11:41Z

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

 Can be one of the following:

-* A string in the username:password format. 
-* An object with the fields `user` and `pass`, similar to the xref:n1ql:n1ql-manage/query-settings.adoc#Credentials[creds] request-level parameter.


Updating this line to remove the link to the creds request-level parameter as it can take any type/form in Capella, and needn't always be an object. Whereas, the creds parameter in the USING AI statement must be either a string or an object.

simon-dew

Thanks!

simon-dew · 2025-11-14T10:27:21Z

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

 [Optional] A JSON object specifying additional <<optional-parameters,options>> for the statement.
 +
-By default, the statement uses the xref:n1ql-rest-query:index.adoc#natural_orgid[natural_orgid], xref:n1ql-rest-query:index.adoc#natural_cred[natural_cred], and xref:n1ql-rest-query:index.adoc#natural_context[natural_context] request-level parameters.
+By default, the statement uses the xref:n1ql:n1ql-manage/query-settings.adoc#natural_orgid[natural_orgid], xref:n1ql:n1ql-manage/query-settings.adoc#natural_cred[natural_cred], and xref:n1ql:n1ql-manage/query-settings.adoc#natural_context[natural_context] request-level parameters.


This is great! Can you backport all xrefs to query-settings.adoc to the release/8.0 branch as well?

simon-dew · 2025-11-14T10:27:47Z

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

 | **creds** +
 __optional__
-| Couchbase Capella credentials to authenticate the request.
+| Couchbase Capella account credentials to authenticate the request. 


This should go to release/8.0 as well

simon-dew · 2025-11-14T10:31:06Z

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

+
+When using the statement, consider the following:
+
+* To run the statement on Capella, use either the cbq shell or an SDK.


What about the Data API?

simon-dew · 2025-11-14T10:31:53Z

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

+When using the statement, consider the following:
+
+* To run the statement on Capella, use either the cbq shell or an SDK.
+The statement does not function as expected when executed directly through the Capella UI (Query Workbench).


Suggested change

The statement does not function as expected when executed directly through the Capella UI (Query Workbench).

The statement does not function when executed directly through the Capella UI (Query tab).

simon-dew · 2025-11-14T10:35:48Z

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

+The statement does not function as expected when executed directly through the Capella UI (Query Workbench).
+* For similar functionality within the Capella UI, use xref:get-started:capella-iq/work-with-capellaiq.adoc[Capella iQ] instead.
+* You cannot use the `creds` and `natural_cred` parameters with the following types of credentials:
+** Single Sign-On (SSO)


Can you please check whether I should add a note about SSO, MFA, and social login to the Data API reference as part of DOC-13662?

simon-dew · 2025-11-14T10:38:29Z

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc

+If specified, this value overrides the xref:n1ql:n1ql-manage/query-settings.adoc#natural_cred[natural_cred] request-level parameter.

-If specified, this value overrides the xref:n1ql-rest-query:index.adoc#natural_cred[natural_cred] request-level parameter.
+This parameter does not support Single Sign-On (SSO), Multi-Factor Authentication (MFA), or social login credentials (such as Google or GitHub).


Backport to release/8.0 as well? (Check)

rakhi-prathap added 2 commits November 7, 2025 15:46

Add limitations and workarounds

dbe5bcd

Language fixes

78390f9

rakhi-prathap commented Nov 7, 2025

View reviewed changes

modules/n1ql/pages/n1ql-language-reference/using-ai.adoc Outdated Show resolved Hide resolved

rakhi-prathap requested review from GauravJayaraj and simon-dew November 7, 2025 11:05

GauravJayaraj suggested changes Nov 10, 2025

View reviewed changes

rijuCB reviewed Nov 10, 2025

View reviewed changes

apply review feedback

ce8718b

GauravJayaraj approved these changes Nov 12, 2025

View reviewed changes

rakhi-prathap added 3 commits November 12, 2025 11:52

Fix broken links

ffcccd5

Fix broken links

612c7cf

Fix the creds parameter

3a90675

rakhi-prathap commented Nov 12, 2025

View reviewed changes

simon-dew requested changes Nov 14, 2025

View reviewed changes


		When using the statement, consider the following:

		* To run the statement on Capella, use either the cbq shell or an SDK.

	The statement does not function as expected when executed directly through the Capella UI (Query Workbench).
	The statement does not function when executed directly through the Capella UI (Query tab).

[DOC-13706] USING AI Limitations #470

Are you sure you want to change the base?

[DOC-13706] USING AI Limitations #470

Uh oh!

Conversation

rakhi-prathap commented Nov 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

GauravJayaraj left a comment

Choose a reason for hiding this comment

Uh oh!

rijuCB left a comment

Choose a reason for hiding this comment

Uh oh!

GauravJayaraj commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GauravJayaraj left a comment

Choose a reason for hiding this comment

Uh oh!

rakhi-prathap Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simon-dew left a comment

Choose a reason for hiding this comment

Uh oh!

simon-dew Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

simon-dew Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

simon-dew Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

RichardSmedley Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

simon-dew Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

simon-dew Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

simon-dew Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rakhi-prathap commented Nov 7, 2025 •

edited

Loading

GauravJayaraj commented Nov 11, 2025 •

edited

Loading

rakhi-prathap Nov 12, 2025 •

edited

Loading