Skip to content

Commit

Permalink
Add a README for /samples
Browse files Browse the repository at this point in the history
I'm making sure all samples in our various repos have a ToC. This matches the Python & REST READMEs, and I can add a GitHub action if you like - just LMK.

 * [Python and REST](google-gemini/generative-ai-python@db311dd)
 * [GitHub action](https://github.com/google-gemini/generative-ai-python/blob/main/.github/workflows/samples.yaml)
  • Loading branch information
markmcd committed Aug 14, 2024
1 parent 2b8f14c commit b7186b1
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions samples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Gemini API Swift SDK sample code

This directory contains sample code for key features of the SDK, organised by high level feature.

These samples are embedded in parts of the [documentation](https://ai.google.dev), most notably in the [API reference](https://ai.google.dev/api).

Each file is structured as a runnable test case, ensuring that samples are executable and functional. Each test demonstrates a single concept, and contains region tags that are used to demarcate the test scaffolding from the spotlight code. If you are contributing, code within region tags should follow sample code best practices - being clear, complete and concise.

## Contents

| File | Description |
| ---- | ----------- |
| [APIKey.swift](./APIKey.swift) | Seetting up your API key |
| [ChatSnippets.swift](./ChatSnippets.swift) | Multi-turn chat conversations |
| [CodeExecution.swift](./CodeExecution.swift) | Executing code |
| [ControlledGeneration.swift](./ControlledGeneration.swift) | Generating content with output constraints (e.g. JSON mode) |
| [CountTokens.swift](./CountTokens.swift) | Counting input and output tokens |
| [FunctionCalling.swift](./FunctionCalling.swift) | Using function calling |
| [GenerationConfig.swift](./GenerationConfig.swift) | Setting model parameters |
| [SafetySettings.swift](./SafetySettings.swift) | Setting and using safety controls |
| [SystemInstructions.swift](./SystemInstructions.swift) | Setting system instructions |
| [TextGeneration.swift](./TextGeneration.swift) | Generating text |

0 comments on commit b7186b1

Please sign in to comment.