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.

Sign up for GitHub

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

Jump to bottom

Internal links as relative one #290

Merged
merged 3 commits into from
Sep 16, 2024
Merged

Internal links as relative one #290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edb7ab6
* Updating template with relative links and instructions regarding links
Giom-V Sep 13, 2024
7ffa527
Making all internal links relative.
Giom-V Sep 13, 2024
8f6c7f0
Use verb form
markmcd Sep 16, 2024
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
6 changes: 3 additions & 3 deletions quickstarts/Audio.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
"source": [
"### Configure your API key\n",
"\n",
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see [Authentication](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Authentication.ipynb) for an example."
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see [Authentication](../quickstarts/Authentication.ipynb) for an example."
]
},
{
Expand All @@ -134,7 +134,7 @@
"source": [
"## Upload an audio file with the File API\n",
"\n",
"To use an audio file in your prompt, you must first upload it using the [File API](https://github.com/google-gemini/cookbook/blob/main/quickstarts/File_API.ipynb).\n"
"To use an audio file in your prompt, you must first upload it using the [File API](../quickstarts/File_API.ipynb).\n"
]
},
{
Expand Down Expand Up @@ -416,7 +416,7 @@
"\n",
"### Continue your discovery of the Gemini API\n",
"\n",
"Have a look at the [Audio](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Audio.ipynb) quickstart to learn about another type of media file, then learn more about [prompting with media files](https://ai.google.dev/tutorials/prompting_with_media) in the docs, including the supported formats and maximum length for audio files. .\n"
"Have a look at the [Audio](../quickstarts/Audio.ipynb) quickstart to learn about another type of media file, then learn more about [prompting with media files](https://ai.google.dev/tutorials/prompting_with_media) in the docs, including the supported formats and maximum length for audio files. .\n"
]
}
],
Expand Down
8 changes: 4 additions & 4 deletions quickstarts/File_API.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"and view the text examples at the end of this guide.\n",
"\n",
"This guide shows how to use the File API to upload a media file and include it in a `GenerateContent` call to the Gemini API. For more information, see the [code\n",
"samples](https://github.com/google-gemini/cookbook/tree/main/quickstarts/file-api).\n"
"samples](../quickstarts/file-api).\n"
]
},
{
Expand Down Expand Up @@ -122,7 +122,7 @@
"source": [
"#### Set up your API key\n",
"\n",
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see [Authentication](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Authentication.ipynb) for an example."
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see [Authentication](../Authentication.ipynb) for an example."
]
},
{
Expand Down Expand Up @@ -160,7 +160,7 @@
"source": [
"First, you will prepare a sample image to upload to the API.\n",
"\n",
"Note: You can also [upload your own files](https://github.com/google-gemini/cookbook/tree/main/examples/Upload_files_to_Colab.ipynb) to use."
"Note: You can also [upload your own files](../examples/Upload_files_to_Colab.ipynb) to use."
]
},
{
Expand Down Expand Up @@ -523,7 +523,7 @@
"## Next Steps\n",
"### Useful API references:\n",
"\n",
"For more information about the File API, check its [API reference](https://ai.google.dev/api/files). You will also find more code samples [in this folder](https://github.com/google-gemini/cookbook/tree/main/quickstarts/file-api).\n",
"For more information about the File API, check its [API reference](https://ai.google.dev/api/files). You will also find more code samples [in this folder](../quickstarts/file-api).\n",
"\n",
"### Related examples\n",
"\n",
Expand Down
12 changes: 6 additions & 6 deletions quickstarts/Video.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@
"id": "l8g4hTRotheH"
},
"source": [
"#### Setup your API key\n",
"#### Set up your API key\n",
"\n",
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see [Authentication](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Authentication.ipynb) for an example."
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see [Authentication](../quickstarts/Authentication.ipynb) for an example."
]
},
{
Expand Down Expand Up @@ -340,19 +340,19 @@
"\n",
"The File API lets you upload a variety of multimodal MIME types, including images, audio, and video formats. The File API handles inputs that can be used to generate content with [`model.generateContent`](https://ai.google.dev/api/rest/v1/models/generateContent) or [`model.streamGenerateContent`](https://ai.google.dev/api/rest/v1/models/streamGenerateContent).\n",
"\n",
"* Learn more about the [File API](https://github.com/google-gemini/cookbook/blob/main/quickstarts/File_API.ipynb) with the quickstart.\n",
"* Learn more about the [File API](../quickstarts/File_API.ipynb) with the quickstart.\n",
"\n",
"* Learn more about prompting with [media files](https://ai.google.dev/tutorials/prompting_with_media) in the docs, including the supported formats and maximum length.\n",
"\n",
"### Related examples\n",
"\n",
"Check those examples videos with the Gemini API to give you more ideas what you can do with them:\n",
"* Analyze videos to [classify](examples/Analyze_a_Video_Classification.ipynb) or [summarize](https://github.com/google-gemini/cookbook/blob/main/examples/Analyze_a_Video_Summarization.ipynb) them\n",
"* Have the Gemini API recognize an [historical moment](examples/Analyze_a_Video_Historic_Event_Recognition.ipynb) and tell you more about it\n",
"* Analyze videos to [classify](../examples/Analyze_a_Video_Classification.ipynb) or [summarize](../examples/Analyze_a_Video_Summarization.ipynb) them\n",
"* Have the Gemini API recognize an [historical moment](../examples/Analyze_a_Video_Historic_Event_Recognition.ipynb) and tell you more about it\n",
"\n",
"### Continue your discovery of the Gemini API\n",
"\n",
"If you're not already familiar with it, learn how [tokens are counted](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Counting_Tokens.ipynb). Then check how to use the File API to use [Audio files](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Audio.ipynb) with the Gemini API.\n"
"If you're not already familiar with it, learn how [tokens are counted](../quickstarts/Counting_Tokens.ipynb). Then check how to use the File API to use [Audio files](../quickstarts/Audio.ipynb) with the Gemini API.\n"
]
}
],
Expand Down
22 changes: 21 additions & 1 deletion templates/Template.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
"source": [
"## Set up your API key\n",
"\n",
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see the [Authentication](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Authentication.ipynb) quickstart for an example."
"To run the following cell, your API key must be stored it in a Colab Secret named `GOOGLE_API_KEY`. If you don't already have an API key, or you're not sure how to create a Colab Secret, see the [Authentication](../quickstarts/Authentication.ipynb) quickstart for an example."
]
},
{
Expand Down Expand Up @@ -132,6 +132,26 @@
"[Add as many high level sections as needed to step through your guide. Try to introduce new concepts incrementally, and remember that notebooks need to be executable from start to finish using `Runtime -> Run all` in Colab.]"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "4677dd58e9b5"
},
"source": [
"## Next Steps\n",
"### Useful API references:\n",
"\n",
"[Always end with links to the related doumentation]\n",
"\n",
"### Related examples\n",
"\n",
"[If any, add links to the related examples]\n",
"\n",
"### Continue your discovery of the Gemini API\n",
"\n",
"[Finally, link some other quickstarts that are either related or require the same level of expertise]\n"
]
},
{
"cell_type": "markdown",
"metadata": {
Expand Down
Loading