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

Add a README for /samples #202

Merged
merged 2 commits into from
Aug 16, 2024
Merged

Add a README for /samples #202

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7186b1
Add a README for /samples
markmcd Aug 14, 2024
d5f110f
Fix typo
markmcd Aug 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
22 changes: 22 additions & 0 deletions samples/README.md
View file
Open in desktop
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) | Setting 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 |
Loading