Skip to content

Commit

Permalink
build based on 8cb5615
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 24, 2024
1 parent de92f6b commit 8d6a21b
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 8 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-24T22:22:57","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-24T23:10:48","documenter_version":"1.2.1"}}
17 changes: 12 additions & 5 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · GoogleGenAI.jl</title><meta name="title" content="API · GoogleGenAI.jl"/><meta property="og:title" content="API · GoogleGenAI.jl"/><meta property="twitter:title" content="API · GoogleGenAI.jl"/><meta name="description" content="Documentation for GoogleGenAI.jl."/><meta property="og:description" content="Documentation for GoogleGenAI.jl."/><meta property="twitter:description" content="Documentation for GoogleGenAI.jl."/><meta property="og:url" content="https://tylerjthomas9.github.io/GoogleGenAI.jl/api/"/><meta property="twitter:url" content="https://tylerjthomas9.github.io/GoogleGenAI.jl/api/"/><link rel="canonical" href="https://tylerjthomas9.github.io/GoogleGenAI.jl/api/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">GoogleGenAI.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/tylerjthomas9/GoogleGenAI.jl.git" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><pre><code class="nohighlight hljs">GoogleProvider
generate_content
count_tokens
embed_content
list_models</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Saturday 24 February 2024 22:22">Saturday 24 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · GoogleGenAI.jl</title><meta name="title" content="API · GoogleGenAI.jl"/><meta property="og:title" content="API · GoogleGenAI.jl"/><meta property="twitter:title" content="API · GoogleGenAI.jl"/><meta name="description" content="Documentation for GoogleGenAI.jl."/><meta property="og:description" content="Documentation for GoogleGenAI.jl."/><meta property="twitter:description" content="Documentation for GoogleGenAI.jl."/><meta property="og:url" content="https://tylerjthomas9.github.io/GoogleGenAI.jl/api/"/><meta property="twitter:url" content="https://tylerjthomas9.github.io/GoogleGenAI.jl/api/"/><link rel="canonical" href="https://tylerjthomas9.github.io/GoogleGenAI.jl/api/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">GoogleGenAI.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/tylerjthomas9/GoogleGenAI.jl.git" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><ul><li><a href="#GoogleGenAI.GoogleProvider"><code>GoogleGenAI.GoogleProvider</code></a></li><li><a href="#GoogleGenAI.count_tokens"><code>GoogleGenAI.count_tokens</code></a></li><li><a href="#GoogleGenAI.embed_content"><code>GoogleGenAI.embed_content</code></a></li><li><a href="#GoogleGenAI.generate_content"><code>GoogleGenAI.generate_content</code></a></li><li><a href="#GoogleGenAI.list_models"><code>GoogleGenAI.list_models</code></a></li></ul><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoogleGenAI.GoogleProvider" href="#GoogleGenAI.GoogleProvider"><code>GoogleGenAI.GoogleProvider</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Base.@kwdef struct GoogleProvider &lt;: AbstractGoogleProvider
api_key::String = &quot;&quot;
base_url::String = &quot;https://generativelanguage.googleapis.com&quot;
api_version::String = &quot;v1beta&quot;
end</code></pre><p>A configuration object used to set up and authenticate requests to the Google Generative Language API.</p><p><strong>Fields</strong></p><ul><li><code>api_key::String</code>: Your Google API key. </li><li><code>base_url::String</code>: The base URL for the Google Generative Language API. The default is set to <code>&quot;https://generativelanguage.googleapis.com&quot;</code>.</li><li><code>api_version::String</code>: The version of the API you wish to access. The default is set to <code>&quot;v1beta&quot;</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tylerjthomas9/GoogleGenAI.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoogleGenAI.generate_content" href="#GoogleGenAI.generate_content"><code>GoogleGenAI.generate_content</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">generate_content(provider::AbstractGoogleProvider, model_name::String, prompt::String, image_path::String; kwargs...) -&gt; GoogleTextResponse
generate_content(api_key::String, model_name::String, prompt::String, image_path::String; kwargs...) -&gt; GoogleTextResponse

generate_content(provider::AbstractGoogleProvider, model_name::String, conversation::Vector{Dict{Symbol,Any}}; kwargs...) -&gt; GoogleTextResponse
generate_content(api_key::String, model_name::String, conversation::Vector{Dict{Symbol,Any}}; kwargs...) -&gt; GoogleTextResponse</code></pre><p>Generate content based on a combination of text prompt and an image (optional).</p><p><strong>Arguments</strong></p><ul><li><code>provider::AbstractGoogleProvider</code>: The provider instance for API requests.</li><li><code>api_key::String</code>: Your Google API key as a string. </li><li><code>model_name::String</code>: The model to use for content generation.</li><li><code>prompt::String</code>: The text prompt to accompany the image.</li><li><code>image_path::String</code> (optional): The path to the image file to include in the request.</li></ul><p><strong>Keyword Arguments</strong></p><ul><li><code>temperature::Float64</code> (optional): Controls the randomness in the generation process. Higher values result in more random outputs. Typically ranges between 0 and 1.</li><li><code>candidate_count::Int</code> (optional): The number of generation candidates to consider. Currently, only one candidate can be specified.</li><li><code>max_output_tokens::Int</code> (optional): The maximum number of tokens that the generated content should contain.</li><li><code>stop_sequences::Vector{String}</code> (optional): A list of sequences where the generation should stop. Useful for defining natural endpoints in generated content.</li><li><code>safety_settings::Vector{Dict}</code> (optional): Settings to control the safety aspects of the generated content, such as filtering out unsafe or inappropriate content.</li></ul><p><strong>Returns</strong></p><ul><li><code>GoogleTextResponse</code>: The generated content response.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tylerjthomas9/GoogleGenAI.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoogleGenAI.count_tokens" href="#GoogleGenAI.count_tokens"><code>GoogleGenAI.count_tokens</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">count_tokens(provider::AbstractGoogleProvider, model_name::String, prompt::String) -&gt; Int
count_tokens(api_key::String, model_name::String, prompt::String) -&gt; Int</code></pre><p>Calculate the number of tokens generated by the specified model for a given prompt string.</p><p><strong>Arguments</strong></p><ul><li><code>provider::AbstractGoogleProvider</code>: The provider instance containing API key and base URL information.</li><li><code>api_key::String</code>: Your Google API key as a string. </li><li><code>model_name::String</code>: The name of the model to use for generating content. </li><li><code>prompt::String</code>: The prompt prompt based on which the text is generated.</li></ul><p><strong>Returns</strong></p><ul><li><code>Int</code>: The total number of tokens that the given prompt string would be broken into by the specified model&#39;s tokenizer.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tylerjthomas9/GoogleGenAI.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoogleGenAI.embed_content" href="#GoogleGenAI.embed_content"><code>GoogleGenAI.embed_content</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">embed_content(provider::AbstractGoogleProvider, model_name::String, prompt::String) -&gt; GoogleEmbeddingResponse
embed_content(api_key::String, model_name::String, prompt::String) -&gt; GoogleEmbeddingResponse</code></pre><p>Generate an embedding for the given prompt text using the specified model.</p><p><strong>Arguments</strong></p><ul><li><code>provider::AbstractGoogleProvider</code>: The provider instance containing API key and base URL information.</li><li><code>api_key::String</code>: Your Google API key as a string. </li><li><code>model_name::String</code>: The name of the model to use for generating content. </li><li><code>prompt::String</code>: The prompt prompt based on which the text is generated.</li></ul><p><strong>Returns</strong></p><ul><li><code>GoogleEmbeddingResponse</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tylerjthomas9/GoogleGenAI.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoogleGenAI.list_models" href="#GoogleGenAI.list_models"><code>GoogleGenAI.list_models</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">list_models(provider::AbstractGoogleProvider) -&gt; Vector{Dict}
list_models(api_key::String) -&gt; Vector{Dict}</code></pre><p>Retrieve a list of available models along with their details from the Google AI API.</p><p><strong>Arguments</strong></p><ul><li><code>provider::AbstractGoogleProvider</code>: The provider instance containing API key and base URL information.</li><li><code>api_key::String</code>: Your Google API key as a string. </li></ul><p><strong>Returns</strong></p><ul><li><code>Vector{Dict}</code>: A list of dictionaries, each containing details about an available model.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tylerjthomas9/GoogleGenAI.jl.git">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Saturday 24 February 2024 23:10">Saturday 24 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 8d6a21b

Please sign in to comment.