Skip to content

Commit 090270b

Browse files
committed
fix format
1 parent 5d0a47d commit 090270b

File tree

2 files changed

+52
-50
lines changed

2 files changed

+52
-50
lines changed

bigframes/bigquery/_operations/ai.py

Lines changed: 51 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,6 @@ def generate(
4949
"""
5050
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
5151
52-
.. note::
53-
54-
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
55-
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
56-
and might have limited support. For more information, see the launch stage descriptions
57-
(https://cloud.google.com/products#product-launch-stages).
58-
5952
**Examples:**
6053
6154
>>> import bigframes.pandas as bpd
@@ -72,13 +65,20 @@ def generate(
7265
1 Ottawa\\n
7366
Name: result, dtype: string
7467
75-
You get structured output when the `output_schema` parameter is set:
68+
You get structured output when the `output_schema` parameter is set:
7669
7770
>>> animals = bpd.Series(["Rabbit", "Spider"])
7871
>>> bbq.ai.generate(animals, output_schema={"number_of_legs": "INT64", "is_herbivore": "BOOL"})
7972
0 {'is_herbivore': True, 'number_of_legs': 4, 'f...
8073
1 {'is_herbivore': False, 'number_of_legs': 8, '...
8174
dtype: struct<is_herbivore: bool, number_of_legs: int64, full_response: extension<dbjson<JSONArrowType>>, status: string>[pyarrow]
75+
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).
8282
8383
Args:
8484
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
@@ -151,13 +151,6 @@ def generate_bool(
151151
"""
152152
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
153153
154-
.. note::
155-
156-
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
157-
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
158-
and might have limited support. For more information, see the launch stage descriptions
159-
(https://cloud.google.com/products#product-launch-stages).
160-
161154
**Examples:**
162155
163156
>>> import bigframes.pandas as bpd
@@ -178,6 +171,13 @@ def generate_bool(
178171
1 True
179172
2 False
180173
Name: result, dtype: boolean
174+
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).
181181
182182
Args:
183183
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
@@ -236,13 +236,6 @@ def generate_int(
236236
"""
237237
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
238238
239-
.. note::
240-
241-
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
242-
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
243-
and might have limited support. For more information, see the launch stage descriptions
244-
(https://cloud.google.com/products#product-launch-stages).
245-
246239
**Examples:**
247240
248241
>>> import bigframes.pandas as bpd
@@ -260,6 +253,13 @@ def generate_int(
260253
1 4
261254
2 8
262255
Name: result, dtype: Int64
256+
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).
263263
264264
Args:
265265
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
@@ -318,13 +318,6 @@ def generate_double(
318318
"""
319319
Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.
320320
321-
.. note::
322-
323-
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
324-
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
325-
and might have limited support. For more information, see the launch stage descriptions
326-
(https://cloud.google.com/products#product-launch-stages).
327-
328321
**Examples:**
329322
330323
>>> import bigframes.pandas as bpd
@@ -342,6 +335,13 @@ def generate_double(
342335
1 4.0
343336
2 8.0
344337
Name: result, dtype: Float64
338+
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).
345345
346346
Args:
347347
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
@@ -398,14 +398,8 @@ def if_(
398398
Evaluates the prompt to True or False. Compared to `ai.generate_bool()`, this function
399399
provides optimization such that not all rows are evaluated with the LLM.
400400
401-
.. note::
402-
403-
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
404-
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
405-
and might have limited support. For more information, see the launch stage descriptions
406-
(https://cloud.google.com/products#product-launch-stages).
407-
408401
**Examples:**
402+
409403
>>> import bigframes.pandas as bpd
410404
>>> import bigframes.bigquery as bbq
411405
>>> bpd.options.display.progress_bar = None
@@ -420,6 +414,13 @@ def if_(
420414
0 Massachusetts
421415
1 Illinois
422416
dtype: string
417+
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).
423424
424425
Args:
425426
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):
@@ -454,13 +455,6 @@ def classify(
454455
"""
455456
Classifies a given input into one of the specified categories. It will always return one of the provided categories best fit the prompt input.
456457
457-
.. note::
458-
459-
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
460-
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
461-
and might have limited support. For more information, see the launch stage descriptions
462-
(https://cloud.google.com/products#product-launch-stages).
463-
464458
**Examples:**
465459
466460
>>> import bigframes.pandas as bpd
@@ -474,6 +468,13 @@ def classify(
474468
1 Salmon Fish
475469
<BLANKLINE>
476470
[2 rows x 2 columns]
471+
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).
477478
478479
Args:
479480
input (str | Series | List[str|Series] | Tuple[str|Series, ...]):
@@ -512,13 +513,6 @@ def score(
512513
There is no fixed range for the score returned. To get high quality results, provide a scoring
513514
rubric with examples in the prompt.
514515
515-
.. note::
516-
517-
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
518-
Service Specific Terms(https://cloud.google.com/terms/service-terms#1). Pre-GA products and features are available "as is"
519-
and might have limited support. For more information, see the launch stage descriptions
520-
(https://cloud.google.com/products#product-launch-stages).
521-
522516
**Examples:**
523517
524518
>>> import bigframes.pandas as bpd
@@ -530,6 +524,13 @@ def score(
530524
1 1.0
531525
2 3.0
532526
dtype: Float64
527+
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).
533534
534535
Args:
535536
prompt (str | Series | List[str|Series] | Tuple[str|Series, ...]):

docs/templates/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@
220220
uid: bigframes.bigquery
221221
- name: BigQuery AI Functions
222222
uid: bigframes.bigquery._operations.ai
223+
status: beta
223224
name: bigframes.bigquery
224225
- items:
225226
- name: GeoSeries

0 commit comments

Comments
 (0)