Skip to content

Commit 86b2cbd

Browse files
committed
doc: fix ai function related docs
1 parent 8514200 commit 86b2cbd

File tree

3 files changed

+52
-5
lines changed

3 files changed

+52
-5
lines changed

bigframes/bigquery/_operations/ai.py

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ def generate(
4848
"""
4949
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
5050
51+
.. note::
52+
53+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
54+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
55+
and might have limited support. For more information, see the launch stage descriptions
56+
(https://cloud.google.com/products#product-launch-stages).
57+
5158
**Examples:**
5259
5360
>>> import bigframes.pandas as bpd
@@ -143,6 +150,13 @@ def generate_bool(
143150
"""
144151
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
145152
153+
.. note::
154+
155+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
156+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
157+
and might have limited support. For more information, see the launch stage descriptions
158+
(https://cloud.google.com/products#product-launch-stages).
159+
146160
**Examples:**
147161
148162
>>> import bigframes.pandas as bpd
@@ -221,6 +235,13 @@ def generate_int(
221235
"""
222236
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
223237
238+
.. note::
239+
240+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
241+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
242+
and might have limited support. For more information, see the launch stage descriptions
243+
(https://cloud.google.com/products#product-launch-stages).
244+
224245
**Examples:**
225246
226247
>>> import bigframes.pandas as bpd
@@ -296,6 +317,13 @@ def generate_double(
296317
"""
297318
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
298319
320+
.. note::
321+
322+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
323+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
324+
and might have limited support. For more information, see the launch stage descriptions
325+
(https://cloud.google.com/products#product-launch-stages).
326+
299327
**Examples:**
300328
301329
>>> import bigframes.pandas as bpd
@@ -369,6 +397,13 @@ def if_(
369397
Evaluates the prompt to True or False. Compared to `ai.generate_bool()`, this function
370398
provides optimization such that not all rows are evaluated with the LLM.
371399
400+
.. note::
401+
402+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
403+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
404+
and might have limited support. For more information, see the launch stage descriptions
405+
(https://cloud.google.com/products#product-launch-stages).
406+
372407
**Examples:**
373408
>>> import bigframes.pandas as bpd
374409
>>> import bigframes.bigquery as bbq
@@ -418,6 +453,13 @@ def classify(
418453
"""
419454
Classifies a given input into one of the specified categories. It will always return one of the provided categories best fit the prompt input.
420455
456+
.. note::
457+
458+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
459+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
460+
and might have limited support. For more information, see the launch stage descriptions
461+
(https://cloud.google.com/products#product-launch-stages).
462+
421463
**Examples:**
422464
423465
>>> import bigframes.pandas as bpd
@@ -469,6 +511,13 @@ def score(
469511
There is no fixed range for the score returned. To get high quality results, provide a scoring
470512
rubric with examples in the prompt.
471513
514+
.. note::
515+
516+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
517+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
518+
and might have limited support. For more information, see the launch stage descriptions
519+
(https://cloud.google.com/products#product-launch-stages).
520+
472521
**Examples:**
473522
474523
>>> import bigframes.pandas as bpd

docs/reference/bigframes.pandas/frame.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,4 @@ Struct handling
3838
AI operators
3939
^^^^^^^^^^^^
4040

41-
.. autoclass:: bigframes.operations.ai.AIAccessor
42-
:members:
43-
:inherited-members:
44-
:undoc-members:
41+
.. automethod:: bigframes.operations.ai.AIAccessor.forecast

docs/templates/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,8 @@
219219
- name: BigQuery built-in functions
220220
uid: bigframes.bigquery
221221
- name: BigQuery AI Functions
222-
uid: bigframes.bigquery.ai
222+
uid: bigframes.bigquery._operations.ai
223+
status: beta
223224
name: bigframes.bigquery
224225
- items:
225226
- name: GeoSeries

0 commit comments

Comments
 (0)