From 15c12087a97d1991b6d871f43c785e633100ff7f Mon Sep 17 00:00:00 2001 From: Mark McDonald Date: Fri, 16 Aug 2024 10:58:12 +0800 Subject: [PATCH] Add a README for /samples (#202) --- samples/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 samples/README.md diff --git a/samples/README.md b/samples/README.md new file mode 100644 index 0000000..86c9335 --- /dev/null +++ b/samples/README.md @@ -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 |