Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add whitespace to generated tables to fix markdown in tables. #602

Merged
merged 8 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions docs/api/google/generativeai.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
description: Google AI Python SDK

<div itemscope itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="google.generativeai" />
<meta itemprop="path" content="Stable" />
<meta itemprop="property" content="__version__"/>
<meta itemprop="property" content="annotations"/>
</div>

# Module: google.generativeai

<!-- Insert buttons and diff -->

<table class="tfo-notebook-buttons tfo-api nocontent" align="left">
<table class="tfo-notebook-buttons tfo-api nocontent">
<td>
<a target="_blank" href="https://github.com/google/generative-ai-python/blob/master/google/generativeai/__init__.py">
<img src="https://www.tensorflow.org/images/GitHub-Mark-32px.png" />
Expand Down Expand Up @@ -52,6 +44,8 @@ See the [python quickstart](https://ai.google.dev/tutorials/python_quickstart) f

## Modules

[`caching`](../google/generativeai/caching.md) module

[`protos`](../google/generativeai/protos.md) module: This module provides low level access to the ProtoBuffer "Message" classes used by the API.

[`types`](../google/generativeai/types.md) module: A collection of type definitions used throughout the library.
Expand All @@ -66,16 +60,8 @@ See the [python quickstart](https://ai.google.dev/tutorials/python_quickstart) f

## Functions

[`chat(...)`](../google/generativeai/chat.md): Calls the API to initiate a chat with a model using provided parameters

[`chat_async(...)`](../google/generativeai/chat_async.md): Calls the API to initiate a chat with a model using provided parameters

[`configure(...)`](../google/generativeai/configure.md): Captures default client configuration.

[`count_message_tokens(...)`](../google/generativeai/count_message_tokens.md): Calls the API to calculate the number of tokens used in the prompt.

[`count_text_tokens(...)`](../google/generativeai/count_text_tokens.md): Calls the API to count the number of tokens in the text prompt.

[`create_tuned_model(...)`](../google/generativeai/create_tuned_model.md): Calls the API to initiate a tuning process that optimizes a model for specific data, returning an operation object to track and manage the tuning progress.

[`delete_file(...)`](../google/generativeai/delete_file.md): Calls the API to permanently delete a specified file using a supported file service.
Expand All @@ -86,10 +72,6 @@ See the [python quickstart](https://ai.google.dev/tutorials/python_quickstart) f

[`embed_content_async(...)`](../google/generativeai/embed_content_async.md): Calls the API to create async embeddings for content passed in.

[`generate_embeddings(...)`](../google/generativeai/generate_embeddings.md): Calls the API to create an embedding for the text passed in.

[`generate_text(...)`](../google/generativeai/generate_text.md): Calls the API to generate text based on the provided prompt.

[`get_base_model(...)`](../google/generativeai/get_base_model.md): Calls the API to fetch a base model by name.

[`get_file(...)`](../google/generativeai/get_file.md): Calls the API to retrieve a specified file using a supported file service.
Expand Down Expand Up @@ -121,17 +103,25 @@ See the [python quickstart](https://ai.google.dev/tutorials/python_quickstart) f

<tr>
<td>

__version__<a id="__version__"></a>

</td>
<td>
`'0.7.2'`

`'0.8.3'`

</td>
</tr><tr>
<td>

annotations<a id="annotations"></a>

</td>
<td>

Instance of `__future__._Feature`

</td>
</tr>
</table>
Expand Down
44 changes: 33 additions & 11 deletions docs/api/google/generativeai/ChatSession.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,9 @@
description: Contains an ongoing conversation with the model.

<div itemscope itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="google.generativeai.ChatSession" />
<meta itemprop="path" content="Stable" />
<meta itemprop="property" content="__init__"/>
<meta itemprop="property" content="rewind"/>
<meta itemprop="property" content="send_message"/>
<meta itemprop="property" content="send_message_async"/>
</div>

# google.generativeai.ChatSession

<!-- Insert buttons and diff -->

<table class="tfo-notebook-buttons tfo-api nocontent" align="left">
<table class="tfo-notebook-buttons tfo-api nocontent">
<td>
<a target="_blank" href="https://github.com/google/generative-ai-python/blob/master/google/generativeai/generative_models.py#L481-L875">
<img src="https://www.tensorflow.org/images/GitHub-Mark-32px.png" />
Expand Down Expand Up @@ -58,17 +48,25 @@ This `ChatSession` object collects the messages sent and received, in its

<tr>
<td>

`model`<a id="model"></a>

</td>
<td>

The model to use in the chat.

</td>
</tr><tr>
<td>

`history`<a id="history"></a>

</td>
<td>

A chat history to initialize the object with.

</td>
</tr>
</table>
Expand All @@ -84,17 +82,25 @@ A chat history to initialize the object with.

<tr>
<td>

`history`<a id="history"></a>

</td>
<td>

The chat history.

</td>
</tr><tr>
<td>

`last`<a id="last"></a>

</td>
<td>

returns the last received `genai.GenerateContentResponse`

</td>
</tr>
</table>
Expand Down Expand Up @@ -167,31 +173,47 @@ Like <a href="../../google/generativeai/GenerativeModel.md#generate_content"><co

<tr>
<td>

`content`

</td>
<td>

The message contents.

</td>
</tr><tr>
<td>

`generation_config`

</td>
<td>

Overrides for the model's generation config.

</td>
</tr><tr>
<td>

`safety_settings`

</td>
<td>

Overrides for the model's safety settings.

</td>
</tr><tr>
<td>

`stream`

</td>
<td>

If True, yield response chunks as they are generated.

</td>
</tr>
</table>
Expand Down
Loading