Skip to content

Commit 93a0749

Browse files
docs: fix ai function related docs (#2149)
* doc: fix ai function related docs * fix docs * fix format * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 8f9cbc3 commit 93a0749

File tree

2 files changed

+53
-2
lines changed

2 files changed

+53
-2
lines changed

bigframes/bigquery/_operations/ai.py

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,21 @@ def generate(
6565
1 Ottawa\\n
6666
Name: result, dtype: string
6767
68-
You get structured output when the `output_schema` parameter is set:
68+
You get structured output when the `output_schema` parameter is set:
6969
7070
>>> animals = bpd.Series(["Rabbit", "Spider"])
7171
>>> bbq.ai.generate(animals, output_schema={"number_of_legs": "INT64", "is_herbivore": "BOOL"})
7272
0 {'is_herbivore': True, 'number_of_legs': 4, 'f...
7373
1 {'is_herbivore': False, 'number_of_legs': 8, '...
7474
dtype: struct<is_herbivore: bool, number_of_legs: int64, full_response: extension<dbjson<JSONArrowType>>, status: string>[pyarrow]
7575
76+
.. note::
77+
78+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
79+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
80+
and might have limited support. For more information, see the launch stage descriptions
81+
(https://cloud.google.com/products#product-launch-stages).
82+
7683
Args:
7784
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
7885
A mixture of Series and string literals that specifies the prompt to send to the model. The Series can be BigFrames Series
@@ -165,6 +172,13 @@ def generate_bool(
165172
2 False
166173
Name: result, dtype: boolean
167174
175+
.. note::
176+
177+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
178+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
179+
and might have limited support. For more information, see the launch stage descriptions
180+
(https://cloud.google.com/products#product-launch-stages).
181+
168182
Args:
169183
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
170184
A mixture of Series and string literals that specifies the prompt to send to the model. The Series can be BigFrames Series
@@ -240,6 +254,13 @@ def generate_int(
240254
2 8
241255
Name: result, dtype: Int64
242256
257+
.. note::
258+
259+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
260+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
261+
and might have limited support. For more information, see the launch stage descriptions
262+
(https://cloud.google.com/products#product-launch-stages).
263+
243264
Args:
244265
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
245266
A mixture of Series and string literals that specifies the prompt to send to the model. The Series can be BigFrames Series
@@ -315,6 +336,13 @@ def generate_double(
315336
2 8.0
316337
Name: result, dtype: Float64
317338
339+
.. note::
340+
341+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
342+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
343+
and might have limited support. For more information, see the launch stage descriptions
344+
(https://cloud.google.com/products#product-launch-stages).
345+
318346
Args:
319347
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
320348
A mixture of Series and string literals that specifies the prompt to send to the model. The Series can be BigFrames Series
@@ -371,6 +399,7 @@ def if_(
371399
provides optimization such that not all rows are evaluated with the LLM.
372400
373401
**Examples:**
402+
374403
>>> import bigframes.pandas as bpd
375404
>>> import bigframes.bigquery as bbq
376405
>>> bpd.options.display.progress_bar = None
@@ -386,6 +415,13 @@ def if_(
386415
1 Illinois
387416
dtype: string
388417
418+
.. note::
419+
420+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
421+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
422+
and might have limited support. For more information, see the launch stage descriptions
423+
(https://cloud.google.com/products#product-launch-stages).
424+
389425
Args:
390426
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
391427
A mixture of Series and string literals that specifies the prompt to send to the model. The Series can be BigFrames Series
@@ -433,6 +469,13 @@ def classify(
433469
<BLANKLINE>
434470
[2 rows x 2 columns]
435471
472+
.. note::
473+
474+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
475+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
476+
and might have limited support. For more information, see the launch stage descriptions
477+
(https://cloud.google.com/products#product-launch-stages).
478+
436479
Args:
437480
input (str | Series | List[str|Series] | Tuple[str|Series, ...]):
438481
A mixture of Series and string literals that specifies the input to send to the model. The Series can be BigFrames Series
@@ -482,6 +525,13 @@ def score(
482525
2 3.0
483526
dtype: Float64
484527
528+
.. note::
529+
530+
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
531+
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
532+
and might have limited support. For more information, see the launch stage descriptions
533+
(https://cloud.google.com/products#product-launch-stages).
534+
485535
Args:
486536
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
487537
A mixture of Series and string literals that specifies the prompt to send to the model. The Series can be BigFrames Series

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)