2369 lines
144 KiB
XML
Executable File
2369 lines
144 KiB
XML
Executable File
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Mscc.GenerativeAI</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="P:Mscc.GenerativeAI.BaseModel.Model">
|
|
<summary>
|
|
Gets or sets the name of the model to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.BaseModel.Name">
|
|
<summary>
|
|
Returns the name of the model.
|
|
</summary>
|
|
<returns>Name of the model.</returns>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.BaseModel.ApiKey">
|
|
<summary>
|
|
Sets the API key to use for the request.
|
|
</summary>
|
|
<remarks>
|
|
The value can only be set or modified before the first request is made.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.AddApiKeyHeader(System.Net.Http.HttpRequestMessage)">
|
|
<summary>
|
|
Specify API key in HTTP header
|
|
</summary>
|
|
<seealso href="https://cloud.google.com/docs/authentication/api-keys-use#using-with-rest">Using an API key with REST</seealso>
|
|
<param name="request"><see cref="T:System.Net.Http.HttpRequestMessage"/> to send to the API.</param>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.BaseModel.AccessToken">
|
|
<summary>
|
|
Sets the access token to use for the request.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.BaseModel.ProjectId">
|
|
<summary>
|
|
Sets the project ID to use for the request.
|
|
</summary>
|
|
<remarks>
|
|
The value can only be set or modified before the first request is made.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.BaseModel.Region">
|
|
<summary>
|
|
Returns the region to use for the request.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.BaseModel.Timeout">
|
|
<summary>
|
|
Gets or sets the timespan to wait before the request times out.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.ThrowIfUnsupportedRequest``1(``0)">
|
|
<summary>
|
|
Throws a <see cref="T:System.NotSupportedException"/>, if the functionality is not supported by combination of settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="projectId"></param>
|
|
<param name="region"></param>
|
|
<param name="model"></param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.ParseUrl(System.String,System.String)">
|
|
<summary>
|
|
Parses the URL template and replaces the placeholder with current values.
|
|
Given two API endpoints for Google AI Gemini and Vertex AI Gemini this
|
|
method uses regular expressions to replace placeholders in a URL template with actual values.
|
|
</summary>
|
|
<param name="url">API endpoint to parse.</param>
|
|
<param name="method">Method part of the URL to inject</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.Serialize``1(``0)">
|
|
<summary>
|
|
Return serialized JSON string of request payload.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.Deserialize``1(System.Net.Http.HttpResponseMessage)">
|
|
<summary>
|
|
Return deserialized object from JSON response.
|
|
</summary>
|
|
<typeparam name="T">Type to deserialize response into.</typeparam>
|
|
<param name="response">Response from an API call in JSON format.</param>
|
|
<returns>An instance of type T.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.DefaultJsonSerializerOptions">
|
|
<summary>
|
|
Get default options for JSON serialization.
|
|
</summary>
|
|
<returns>default options for JSON serialization.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.GetCredentialsFromFile(System.String)">
|
|
<summary>
|
|
Get credentials from specified file.
|
|
</summary>
|
|
<remarks>This would usually be the secret.json file from Google Cloud Platform.</remarks>
|
|
<param name="credentialsFile">File with credentials to read.</param>
|
|
<returns>Credentials read from file.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.GetAccessTokenFromAdc">
|
|
<summary>
|
|
This method uses the gcloud command-line tool to retrieve an access token from the Application Default Credentials (ADC).
|
|
It is specific to Google Cloud Platform and allows easy authentication with the Gemini API on Google Cloud.
|
|
Reference: https://cloud.google.com/docs/authentication
|
|
</summary>
|
|
<returns>The access token.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.RunExternalExe(System.String,System.String)">
|
|
<summary>
|
|
Run an external application as process in the underlying operating system, if possible.
|
|
</summary>
|
|
<param name="filename">The command or application to run.</param>
|
|
<param name="arguments">Optional arguments given to the application to run.</param>
|
|
<returns>Output from the application.</returns>
|
|
<exception cref="T:System.Exception"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BaseModel.Format(System.String,System.String)">
|
|
<summary>
|
|
Formatting string for logging purpose.
|
|
</summary>
|
|
<param name="filename">The command or application to run.</param>
|
|
<param name="arguments">Optional arguments given to the application to run.</param>
|
|
<returns>Formatted string containing parameter values.</returns>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.CachedContentModel">
|
|
<summary>
|
|
Content that has been preprocessed and can be used in subsequent request to GenerativeService.
|
|
Cached content can be only used with model it was created for.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.CachedContentModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.CachedContentModel"/> class.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.Create(Mscc.GenerativeAI.CachedContent,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates CachedContent resource.
|
|
</summary>
|
|
<param name="request">The cached content resource to create.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>The cached content resource created</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.Create(System.String,System.String,Mscc.GenerativeAI.Content,System.Collections.Generic.List{Mscc.GenerativeAI.Content},System.Collections.Generic.List{Mscc.GenerativeAI.ContentResponse},System.Nullable{System.TimeSpan},System.Nullable{System.DateTime},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates CachedContent resource.
|
|
</summary>
|
|
<remarks>The minimum input token count for context caching is 32,768, and the maximum is the same as the maximum for the given model.</remarks>
|
|
<param name="model">Required. The name of the `Model` to use for cached content Format: `models/{model}`</param>
|
|
<param name="displayName">Optional. The user-generated meaningful display name of the cached content. Maximum 128 Unicode characters.</param>
|
|
<param name="systemInstruction">Optional. Input only. Developer set system instruction. Currently, text only.</param>
|
|
<param name="contents">Optional. Input only. The content to cache.</param>
|
|
<param name="history">Optional. A chat history to initialize the session with.</param>
|
|
<param name="ttl">Optional. Input only. New TTL for this resource, input only. A duration in seconds with up to nine fractional digits, ending with 's'</param>
|
|
<param name="expireTime">Optional. Timestamp in UTC of when this resource is considered expired. This is always provided on output, regardless of what was sent on input.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>The created cached content resource.</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="model"/> is <see langword="null"/> or empty.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.List(System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Lists CachedContents resources.
|
|
</summary>
|
|
<param name="pageSize">Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.</param>
|
|
<param name="pageToken">Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.Get(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Reads CachedContent resource.
|
|
</summary>
|
|
<param name="cachedContentName">Required. The resource name referring to the content cache entry. Format: `cachedContents/{id}`</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>The cached content resource.</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="cachedContentName"/> is <see langword="null"/> or empty.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.Update(Mscc.GenerativeAI.CachedContent,System.TimeSpan,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Updates CachedContent resource (only expiration is updatable).
|
|
</summary>
|
|
<param name="request">The cached content resource to update.</param>
|
|
<param name="ttl">Optional. Input only. New TTL for this resource, input only. A duration in seconds with up to nine fractional digits, ending with 's'</param>
|
|
<param name="updateMask">Optional. The list of fields to update.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>The updated cached content resource.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="request.Name.Name"/> is <see langword="null"/> or empty.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CachedContentModel.Delete(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Deletes CachedContent resource.
|
|
</summary>
|
|
<param name="cachedContentName">Required. The resource name referring to the content cache entry. Format: `cachedContents/{id}`</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>If successful, the response body is empty.</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="cachedContentName"/> is <see langword="null"/> or empty.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ChatModel.AddApiKeyHeader(System.Net.Http.HttpRequestMessage)">
|
|
<inheritdoc cref="T:Mscc.GenerativeAI.BaseModel"/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ChatModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ChatModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ChatModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ChatModel"/> class.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ChatModel.Completions(Mscc.GenerativeAI.ChatCompletionsRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a set of responses from the model given a chat history input.
|
|
</summary>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.ApiVersion">
|
|
<summary>
|
|
Helper class to provide API versions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.Model">
|
|
<summary>
|
|
Helper class to provide model names.
|
|
Ref: https://cloud.google.com/vertex-ai/generative-ai/docs/learn/model-versioning#latest-version
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Model.Imagen3Customization">
|
|
<summary>
|
|
Imagen 3 Generation is a Pre-GA. Allowlisting required.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Model.ImageGeneration3">
|
|
<summary>
|
|
Imagen 3 Generation is a Pre-GA. Allowlisting required.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Model.ImageGeneration3Fast">
|
|
<summary>
|
|
Imagen 3 Generation is a Pre-GA. Allowlisting required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.Role">
|
|
<summary>
|
|
Possible roles.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.CorporaModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.CorporaModel"/> class.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.Create(Mscc.GenerativeAI.Corpus,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates an empty `Corpus`.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.Get(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Gets information about a specific `Corpus`.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.List(System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Lists all `Corpora` owned by the user.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.Delete(System.String,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Deletes a `Corpus`.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.Update(System.String,Mscc.GenerativeAI.Corpus,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Updates a `Corpus`.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.CorporaModel.Query(Mscc.GenerativeAI.QueryCorpusRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Performs semantic search over a `Corpus`.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.EmbeddingsModel">
|
|
<summary>
|
|
Generates embeddings from the model given an input.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.EmbeddingsModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.EmbeddingsModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.EmbeddingsModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.EmbeddingsModel"/> class.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.EmbeddingsModel.Embeddings(Mscc.GenerativeAI.GenerateEmbeddingsRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates embeddings from the model given an input.
|
|
</summary>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.AdapterSize">
|
|
<summary>
|
|
Adapter size for tuning job.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AdapterSize.AdapterSizeUnspecified">
|
|
<summary>
|
|
Unspecified adapter size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AdapterSize.AdapterSizeOne">
|
|
<summary>
|
|
Adapter size 1.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AdapterSize.AdapterSizeFour">
|
|
<summary>
|
|
Adapter size 4.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AdapterSize.AdapterSizeEight">
|
|
<summary>
|
|
Adapter size 8.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AdapterSize.AdapterSizeSixteen">
|
|
<summary>
|
|
Adapter size 16.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.AnswerStyle">
|
|
<summary>
|
|
Style for grounded answers.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AnswerStyle.AnswerStyleUnspecified">
|
|
<summary>
|
|
Unspecified answer style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AnswerStyle.Abstractive">
|
|
<summary>
|
|
Succinct but abstract style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AnswerStyle.Extractive">
|
|
<summary>
|
|
Very brief and extractive style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.AnswerStyle.Verbose">
|
|
<summary>
|
|
Verbose style including extra details. The response may be formatted as a sentence, paragraph, multiple paragraphs, or bullet points, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.BlockedReason">
|
|
<summary>
|
|
A list of reasons why content may have been blocked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.BlockedReason.BlockedReasonUnspecified">
|
|
<summary>
|
|
BlockedReasonUnspecified means unspecified blocked reason.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.BlockedReason.Safety">
|
|
<summary>
|
|
Safety means candidates blocked due to safety.
|
|
You can inspect <see cref="T:Mscc.GenerativeAI.SafetyRating"/>s to understand which safety category blocked it.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.BlockedReason.Other">
|
|
<summary>
|
|
Prompt was blocked due to unknown reasons.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.BlockedReason.Blocklist">
|
|
<summary>
|
|
Prompt was blocked due to the terms which are included from the terminology blocklist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.BlockedReason.ProhibitedContent">
|
|
<summary>
|
|
Prompt was blocked due to prohibited content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.BlockedReason.ImageSafety">
|
|
<summary>
|
|
Candidates blocked due to unsafe image generation content.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.DynamicRetrievalConfigMode">
|
|
<summary>
|
|
The mode of the predictor to be used in dynamic retrieval.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.DynamicRetrievalConfigMode.ModeUnspecified">
|
|
<summary>
|
|
Always trigger retrieval.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.DynamicRetrievalConfigMode.ModeDynamic">
|
|
<summary>
|
|
Run retrieval only when system decides it is necessary.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.FileResourceSource">
|
|
<summary>
|
|
Source of the File.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FileResourceSource.SourceUnspecified">
|
|
<summary>
|
|
Used if source is not specified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FileResourceSource.Uploaded">
|
|
<summary>
|
|
Indicates the file is uploaded by the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FileResourceSource.Generated">
|
|
<summary>
|
|
Indicates the file is generated by Google.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.FinishReason">
|
|
<summary>
|
|
The reason why the model stopped generating tokens.
|
|
If empty, the model has not stopped generating the tokens.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.FinishReasonUnspecified">
|
|
<summary>
|
|
Unspecified means the finish reason is unspecified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.Stop">
|
|
<summary>
|
|
Stop means natural stop point of the model or provided stop sequence.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.MaxTokens">
|
|
<summary>
|
|
MaxTokens means the maximum number of tokens as specified in the request was reached.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.Safety">
|
|
<summary>
|
|
Safety means the token generation was stopped as the response was flagged for safety
|
|
reasons. NOTE: When streaming the Candidate.Content will be empty if
|
|
content filters blocked the output.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.Recitation">
|
|
<summary>
|
|
Recitation means the token generation was stopped as the response was flagged for
|
|
unauthorized citations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.Other">
|
|
<summary>
|
|
Other means all other reasons that stopped the token generation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.Blocklist">
|
|
<summary>
|
|
The token generation was stopped as the response was flagged for the
|
|
terms which are included from the terminology blocklist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.ProhibitedContent">
|
|
<summary>
|
|
The token generation was stopped as the response was flagged for
|
|
the prohibited contents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.Spii">
|
|
<summary>
|
|
The token generation was stopped as the response was flagged for
|
|
Sensitive Personally Identifiable Information (SPII) contents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.MalformedFunctionCall">
|
|
<summary>
|
|
The function call generated by the model is invalid.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.Language">
|
|
<summary>
|
|
The response candidate content was flagged for using an unsupported language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FinishReason.ImageSafety">
|
|
<summary>
|
|
Token generation stopped because generated images contain safety violations.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.FunctionCallingMode">
|
|
<summary>
|
|
Mode of function calling to define the execution behavior for function calling.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FunctionCallingMode.ModeUnspecified">
|
|
<summary>
|
|
Unspecified function calling mode. This value should not be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FunctionCallingMode.Auto">
|
|
<summary>
|
|
Default model behavior, model decides to predict either a function call
|
|
or a natural language response.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FunctionCallingMode.Any">
|
|
<summary>
|
|
Model is constrained to always predicting a function call only.
|
|
If "allowed_function_names" are set, the predicted function call will be
|
|
limited to any one of "allowed_function_names", else the predicted
|
|
function call will be any one of the provided "function_declarations".
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.FunctionCallingMode.None">
|
|
<summary>
|
|
Model will not predict any function call. Model behavior is same as when
|
|
not passing any function declarations.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.HarmBlockMethod">
|
|
<summary>
|
|
Probability vs severity.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockMethod.HarnBlockMethodUnspecified">
|
|
<summary>
|
|
The harm block method is unspecified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockMethod.Severity">
|
|
<summary>
|
|
The harm block method uses both probability and severity scores.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockMethod.Probability">
|
|
<summary>
|
|
The harm block method uses the probability score.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.HarmBlockThreshold">
|
|
<summary>
|
|
Block at and beyond a specified harm probability.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockThreshold.HarmBlockThresholdUnspecified">
|
|
<summary>
|
|
Threshold is unspecified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockThreshold.BlockLowAndAbove">
|
|
<summary>
|
|
Content with NEGLIGIBLE will be allowed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockThreshold.BlockMediumAndAbove">
|
|
<summary>
|
|
Content with NEGLIGIBLE and LOW will be allowed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockThreshold.BlockOnlyHigh">
|
|
<summary>
|
|
Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockThreshold.BlockNone">
|
|
<summary>
|
|
All content will be allowed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmBlockThreshold.None">
|
|
<summary>
|
|
Turn off the safety filter.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.HarmCategory">
|
|
<summary>
|
|
The category of a rating.
|
|
Ref: https://ai.google.dev/api/rest/v1beta/HarmCategory
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryUnspecified">
|
|
<summary>
|
|
HarmCategoryUnspecified means the harm category is unspecified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryHateSpeech">
|
|
<summary>
|
|
HarmCategoryHateSpeech means the harm category is hate speech.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryDangerousContent">
|
|
<summary>
|
|
HarmCategoryDangerousContent means the harm category is dangerous content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryHarassment">
|
|
<summary>
|
|
HarmCategoryHarassment means the harm category is harassment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategorySexuallyExplicit">
|
|
<summary>
|
|
HarmCategorySexuallyExplicit means the harm category is sexually explicit content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryCivicIntegrity">
|
|
<summary>
|
|
Content that may be used to harm civic integrity.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryDerogatory">
|
|
<summary>
|
|
Negative or harmful comments targeting identity and/or protected attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryToxicity">
|
|
<summary>
|
|
Content that is rude, disrespectful, or profane.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryViolence">
|
|
<summary>
|
|
Describes scenarios depicting violence against an individual or group, or general descriptions of gore.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategorySexual">
|
|
<summary>
|
|
Contains references to sexual acts or other lewd content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryMedical">
|
|
<summary>
|
|
Promotes unchecked medical advice.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmCategory.HarmCategoryDangerous">
|
|
<summary>
|
|
Dangerous content that promotes, facilitates, or encourages harmful acts.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.HarmProbability">
|
|
<summary>
|
|
The probability that a piece of content is harmful.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmProbability.HarmProbabilityUnspecified">
|
|
<summary>
|
|
Unspecified means harm probability unspecified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmProbability.Negligible">
|
|
<summary>
|
|
Negligible means negligible level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmProbability.Low">
|
|
<summary>
|
|
Low means low level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmProbability.Medium">
|
|
<summary>
|
|
Medium means medium level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmProbability.High">
|
|
<summary>
|
|
High means high level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.HarmSeverity">
|
|
<summary>
|
|
Harm severity levels.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmSeverity.HarmSeverityUnspecified">
|
|
<summary>
|
|
Unspecified means harm probability unspecified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmSeverity.HarmSeverityNegligible">
|
|
<summary>
|
|
Negligible means negligible level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmSeverity.HarmSeverityLow">
|
|
<summary>
|
|
Low means low level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmSeverity.HarmSeverityMedium">
|
|
<summary>
|
|
Medium means medium level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.HarmSeverity.HarmSeverityHigh">
|
|
<summary>
|
|
High means high level of harm.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.Language">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Language.LanguageUnspecified">
|
|
<summary>
|
|
Unspecified language. This value should not be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Language.Python">
|
|
<summary>
|
|
Python >= 3.10, with numpy and simpy available.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.MediaResolution">
|
|
<summary>
|
|
The media resolution
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.MediaResolution.MediaResolutionUnspecified">
|
|
<summary>
|
|
Media resolution has not been set.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.MediaResolution.MediaResolutionLow">
|
|
<summary>
|
|
Media resolution set to low (64 tokens).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.MediaResolution.MediaResolutionMedium">
|
|
<summary>
|
|
Media resolution set to medium (256 tokens).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.MediaResolution.MediaResolutionHigh">
|
|
<summary>
|
|
Media resolution set to high (zoomed reframing with 256 tokens).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.Modality">
|
|
<summary>
|
|
The modality associated with a token count.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Modality.ModalityUnspecified">
|
|
<summary>
|
|
Unspecified modality.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Modality.Text">
|
|
<summary>
|
|
Plain text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Modality.Image">
|
|
<summary>
|
|
Image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Modality.Video">
|
|
<summary>
|
|
Video.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Modality.Audio">
|
|
<summary>
|
|
Audio.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Modality.Document">
|
|
<summary>
|
|
Document, e.g. PDF.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.Operator">
|
|
<summary>
|
|
Defines the valid operators that can be applied to a key-value pair.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.OperatorUnspecified">
|
|
<summary>
|
|
The default value. This value is unused.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.Less">
|
|
<summary>
|
|
Supported by numeric.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.LessEqual">
|
|
<summary>
|
|
Supported by numeric.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.Equal">
|
|
<summary>
|
|
Supported by numeric and string.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.GreaterEqual">
|
|
<summary>
|
|
Supported by numeric.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.Greater">
|
|
<summary>
|
|
Supported by numeric.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.NotEqual">
|
|
<summary>
|
|
Supported by numeric and string.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.Includes">
|
|
<summary>
|
|
Supported by string only when <see cref="T:Mscc.GenerativeAI.CustomMetadata" /> value type for the given key has a stringListValue.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Operator.Excludes">
|
|
<summary>
|
|
Supported by string only when <see cref="T:Mscc.GenerativeAI.CustomMetadata" /> value type for the given key has a stringListValue.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.Outcome">
|
|
<summary>
|
|
Outcome of the code execution.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Outcome.OutcomeUnspecified">
|
|
<summary>
|
|
Unspecified status. This value should not be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Outcome.OutcomeOk">
|
|
<summary>
|
|
Code execution completed successfully.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Outcome.OutcomeFailed">
|
|
<summary>
|
|
Code execution finished but with a failure. `stderr` should contain the reason.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.Outcome.OutcomeDeadlineExceeded">
|
|
<summary>
|
|
Code execution ran for too long, and was cancelled. There may or may not be a partial output present.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.ParameterType">
|
|
<summary>
|
|
Type contains the list of OpenAPI data types as defined by https://spec.openapis.org/oas/v3.0.3#data-types
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ParameterType.TypeUnspecified">
|
|
<summary>
|
|
Unspecified means not specified, should not be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ParameterType.String">
|
|
<summary>
|
|
String means openAPI string type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ParameterType.Number">
|
|
<summary>
|
|
Number means openAPI number type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ParameterType.Integer">
|
|
<summary>
|
|
Integer means openAPI integer type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ParameterType.Boolean">
|
|
<summary>
|
|
Boolean means openAPI boolean type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ParameterType.Array">
|
|
<summary>
|
|
Array means openAPI array type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ParameterType.Object">
|
|
<summary>
|
|
Object means openAPI object type
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.ReferenceType">
|
|
<summary>
|
|
Describes what the field reference contains.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.Path">
|
|
<summary>
|
|
Reference contains a GFS path or a local path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.BlobRef">
|
|
<summary>
|
|
Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.Inline">
|
|
<summary>
|
|
Data is included into this proto buffer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.GetMedia">
|
|
<summary>
|
|
Data should be accessed from the current service using the operation GetMedia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.CompositeMedia">
|
|
<summary>
|
|
The content for this media object is stored across multiple partial media objects under the composite_media field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.BigstoreRef">
|
|
<summary>
|
|
Reference points to a bigstore object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.DiffVersionResponse">
|
|
<summary>
|
|
Indicates the data is stored in diff_version_response.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.DiffChecksumResponse">
|
|
<summary>
|
|
Indicates the data is stored in diff_checksums_response.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.DiffDownloadResponse">
|
|
<summary>
|
|
Indicates the data is stored in diff_download_response.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.DiffUploadRequest">
|
|
<summary>
|
|
Indicates the data is stored in diff_upload_request.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.DiffUploadResponse">
|
|
<summary>
|
|
Indicates the data is stored in diff_upload_response.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.CosmoBinaryReference">
|
|
<summary>
|
|
Indicates the data is stored in cosmo_binary_reference.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ReferenceType.ArbitraryBytes">
|
|
<summary>
|
|
Informs Scotty to generate a response payload with the size specified in the length field.
|
|
The contents of the payload are generated by Scotty and are undefined.
|
|
This is useful for testing download speeds between the user and Scotty
|
|
without involving a real payload source. Note: range is not supported when using arbitrary_bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.ResponseModality">
|
|
<summary>
|
|
The requested modalities of the response.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ResponseModality.ModalityUnspecified">
|
|
<summary>
|
|
Default value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ResponseModality.Text">
|
|
<summary>
|
|
Indicates the model should return text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ResponseModality.Image">
|
|
<summary>
|
|
Indicates the model should return images.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.ResponseModality.Audio">
|
|
<summary>
|
|
Indicates the model should return audio.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.State">
|
|
<summary>
|
|
The state of the tuned model.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.State.StateUnspecified">
|
|
<summary>
|
|
The default value. This value is unused.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.State.Creating">
|
|
<summary>
|
|
The model is being created.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.State.Active">
|
|
<summary>
|
|
The model is ready to be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.State.Failed">
|
|
<summary>
|
|
The model failed to be created.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.StateChunk">
|
|
<summary>
|
|
Output only. Current state of the Chunk.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateChunk.StateUnspecified">
|
|
<summary>
|
|
The default value. This value is used if the state is omitted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateChunk.StatePendingProcessing">
|
|
<summary>
|
|
Chunk is being processed (embedding and vector storage).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateChunk.StateActive">
|
|
<summary>
|
|
Chunk is processed and available for querying.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateChunk.StateFailed">
|
|
<summary>
|
|
Chunk failed processing.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.StateFileResource">
|
|
<summary>
|
|
States for the lifecycle of a File.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateFileResource.StateUnspecified">
|
|
<summary>
|
|
The default value. This value is used if the state is omitted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateFileResource.Processing">
|
|
<summary>
|
|
File is being processed and cannot be used for inference yet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateFileResource.Active">
|
|
<summary>
|
|
File is processed and available for inference.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateFileResource.Failed">
|
|
<summary>
|
|
File failed processing.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.StateGeneratedFile">
|
|
<summary>
|
|
The state of the tuned model.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateGeneratedFile.StateUnspecified">
|
|
<summary>
|
|
The default value. This value is used if the state is omitted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateGeneratedFile.Generating">
|
|
<summary>
|
|
Being generated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateGeneratedFile.Generated">
|
|
<summary>
|
|
Generated and is ready for download.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateGeneratedFile.Failed">
|
|
<summary>
|
|
Failed to generate the GeneratedFile.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.StateTuningJob">
|
|
<summary>
|
|
The state of the tuning job.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateTuningJob.StateUnspecified">
|
|
<summary>
|
|
The default value. This value is unused.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateTuningJob.JobStateRunning">
|
|
<summary>
|
|
The tuning job is running.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateTuningJob.JobStatePending">
|
|
<summary>
|
|
The tuning job is pending.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateTuningJob.JobStateFailed">
|
|
<summary>
|
|
The tuning job failed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.StateTuningJob.JobStateCancelled">
|
|
<summary>
|
|
The tuning job has been cancelled.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.TaskType">
|
|
<summary>
|
|
Type of task for which the embedding will be used.
|
|
Ref: https://ai.google.dev/api/rest/v1beta/TaskType
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.TaskTypeUnspecified">
|
|
<summary>
|
|
Unset value, which will default to one of the other enum values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.RetrievalQuery">
|
|
<summary>
|
|
Specifies the given text is a query in a search/retrieval setting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.RetrievalDocument">
|
|
<summary>
|
|
Specifies the given text is a document from the corpus being searched.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.SemanticSimilarity">
|
|
<summary>
|
|
Specifies the given text will be used for STS.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.Classification">
|
|
<summary>
|
|
Specifies that the given text will be classified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.Clustering">
|
|
<summary>
|
|
Specifies that the embeddings will be used for clustering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.QuestionAnswering">
|
|
<summary>
|
|
Specifies that the given text will be used for question answering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Mscc.GenerativeAI.TaskType.FactVerification">
|
|
<summary>
|
|
Specifies that the given text will be used for fact verification.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BlockedPromptException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BlockedPromptException" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BlockedPromptException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BlockedPromptException" /> class
|
|
with a specific message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BlockedPromptException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BlockedPromptException" /> class
|
|
with a specific message that describes the current exception and an inner exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.BlockedPromptException.#ctor(Mscc.GenerativeAI.PromptFeedback)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BlockedPromptException" /> class
|
|
with the block reason message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.MaxUploadFileSizeException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.MaxUploadFileSizeException" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.MaxUploadFileSizeException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.MaxUploadFileSizeException" /> class
|
|
with a specific message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.MaxUploadFileSizeException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.MaxUploadFileSizeException" /> class
|
|
with a specific message that describes the current exception and an inner exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.UploadFileException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.UploadFileException" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.UploadFileException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.UploadFileException" /> class
|
|
with a specific message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.UploadFileException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.UploadFileException" /> class
|
|
with a specific message that describes the current exception and an inner exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ValueErrorException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ValueErrorException" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ValueErrorException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ValueErrorException" /> class
|
|
with a specific message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ValueErrorException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ValueErrorException" /> class
|
|
with a specific message that describes the current exception and an inner exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.StopCandidateException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.StopCandidateException" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.StopCandidateException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.StopCandidateException" /> class
|
|
with a specific message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.StopCandidateException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.StopCandidateException" /> class
|
|
with a specific message that describes the current exception and an inner exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.StopCandidateException.#ctor(Mscc.GenerativeAI.Candidate)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.StopCandidateException" /> class
|
|
with the finish message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.FilesModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.FilesModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.FilesModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.FilesModel"/> class.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.FilesModel.ListFiles(System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Lists the metadata for Files owned by the requesting project.
|
|
</summary>
|
|
<param name="pageSize">The maximum number of Models to return (per page).</param>
|
|
<param name="pageToken">A page token, received from a previous ListFiles call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List of files in File API.</returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.FilesModel.GetFile(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Gets the metadata for the given File.
|
|
</summary>
|
|
<param name="file">Required. The resource name of the file to get. This name should match a file name returned by the ListFiles method. Format: files/file-id.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Metadata for the given file.</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="file"/> is <see langword="null"/> or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.FilesModel.DeleteFile(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Deletes a file.
|
|
</summary>
|
|
<param name="file">Required. The resource name of the file to get. This name should match a file name returned by the ListFiles method. Format: files/file-id.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>If successful, the response body is empty.</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="file"/> is <see langword="null"/> or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GeneratedFilesModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GeneratedFilesModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GeneratedFilesModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GeneratedFilesModel"/> class.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GeneratedFilesModel.ListFiles(System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Lists the generated files owned by the requesting project.
|
|
</summary>
|
|
<param name="pageSize">The maximum number of Models to return (per page).</param>
|
|
<param name="pageToken">A page token, received from a previous ListFiles call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List of files in File API.</returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.GuardApiKey(System.String)">
|
|
<summary>
|
|
Checks whether the API key has the right conditions.
|
|
</summary>
|
|
<param name="apiKey">API key for the Gemini API.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="apiKey"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="apiKey"/> is empty.</exception>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="apiKey"/> has extra whitespace at the start or end, doesn't start with 'AIza', or has the wrong length.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.GuardSupported(Mscc.GenerativeAI.GenerativeModel,System.String)">
|
|
<summary>
|
|
Checks if the functionality is supported by the model.
|
|
</summary>
|
|
<param name="model">Model to use.</param>
|
|
<param name="message">Message to use.</param>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.GuardInlineDataMimeType(System.String)">
|
|
<summary>
|
|
Checks if the IANA standard MIME type is supported by the model.
|
|
</summary>
|
|
<remarks>
|
|
See <see href="https://ai.google.dev/gemini-api/docs/vision"/> for a list of supported image data and video format MIME types.
|
|
See <see href="https://ai.google.dev/gemini-api/docs/audio"/> for a list of supported audio format MIME types.
|
|
</remarks>
|
|
<param name="mimeType">The IANA standard MIME type to check.</param>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="mimeType"/> is not supported by the API.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.GuardMimeType(System.String)">
|
|
<summary>
|
|
Checks if the IANA standard MIME type is supported by the model.
|
|
</summary>
|
|
<remarks>
|
|
See <see href="https://ai.google.dev/gemini-api/docs/vision"/> for a list of supported image data and video format MIME types.
|
|
See <see href="https://ai.google.dev/gemini-api/docs/audio"/> for a list of supported audio format MIME types.
|
|
See also <seealso href="https://ai.google.dev/gemini-api/docs/document-processing"/> for a list of supported MIME types for document processing.
|
|
Ref: https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
|
|
</remarks>
|
|
<param name="mimeType">The IANA standard MIME type to check.</param>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="mimeType"/> is not supported by the API.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.GuardSupportedLanguage(System.String)">
|
|
<summary>
|
|
Checks if the language is supported by the model.
|
|
</summary>
|
|
<param name="language">Language to use.</param>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="language"/> is not supported by the API.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.EnsureSuccessAsync(System.Net.Http.HttpResponseMessage,System.String,System.Boolean)">
|
|
<summary>
|
|
Throws an exception if the IsSuccessStatusCode property for the HTTP response is false.
|
|
</summary>
|
|
<param name="response">The HTTP response message to check.</param>
|
|
<param name="errorMessage">Custom error message to prepend the <see cref="T:System.Net.Http.HttpRequestException"/> message."/></param>
|
|
<param name="includeResponseContent">Include the response content in the error message.</param>
|
|
<returns>The HTTP response message if the call is successful.</returns>
|
|
<exception cref="T:System.Net.Http.HttpRequestException"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.Truncate(System.String,System.Int32,System.String)">
|
|
<summary>
|
|
Truncates/abbreviates a string and places a user-facing indicator at the end.
|
|
</summary>
|
|
<param name="value">The string to truncate.</param>
|
|
<param name="maxLength">Maximum length of the resulting string.</param>
|
|
<param name="suffix">Optional. Indicator to use, by default the ellipsis …</param>
|
|
<returns>The truncated string</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="suffix"/> parameter is null or empty.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the length of the <paramref name="suffix"/> is larger than the <paramref name="maxLength"/>.</exception>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.GenerativeModel.Version">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseServerSentEventsFormat">
|
|
<summary>
|
|
You can enable Server Sent Events (SSE) for gemini-1.0-pro
|
|
</summary>
|
|
<remarks>
|
|
See <a href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events">Server-sent Events</a>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseJsonMode">
|
|
<summary>
|
|
Activate JSON Mode (default = no)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseGrounding">
|
|
<summary>
|
|
Activate Grounding with Google Search (default = no)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseGoogleSearch">
|
|
<summary>
|
|
Activate Google Search (default = no)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseRealtime">
|
|
<summary>
|
|
Enable realtime stream using Multimodal Live API
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.ThrowIfUnsupportedRequest``1(``0)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class.
|
|
The default constructor attempts to read <c>.env</c> file and environment variables.
|
|
Sets default values, if available.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(System.String,System.String,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.Content,Mscc.GenerativeAI.ToolConfig,System.Boolean,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class with access to Google AI Gemini API.
|
|
</summary>
|
|
<param name="apiKey">API key provided by Google AI Studio</param>
|
|
<param name="model">Model to use</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="tools">Optional. A list of Tools the model may use to generate the next response.</param>
|
|
<param name="systemInstruction">Optional. </param>
|
|
<param name="toolConfig">Optional. Configuration of tools.</param>
|
|
<param name="vertexAi">Optional. Flag to indicate use of Vertex AI in express mode.</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(System.String,System.String,System.String,System.String,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.Content,Mscc.GenerativeAI.ToolConfig,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class with access to Vertex AI Gemini API.
|
|
</summary>
|
|
<param name="projectId">Identifier of the Google Cloud project</param>
|
|
<param name="region">Region to use</param>
|
|
<param name="model">Model to use</param>
|
|
<param name="endpoint">Optional. Endpoint ID of the tuned model to use.</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="tools">Optional. A list of Tools the model may use to generate the next response.</param>
|
|
<param name="systemInstruction">Optional. </param>
|
|
<param name="toolConfig">Optional. Configuration of tools.</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(Mscc.GenerativeAI.CachedContent,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class given cached content.
|
|
</summary>
|
|
<param name="cachedContent">Content that has been preprocessed.</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="cachedContent"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(Mscc.GenerativeAI.TuningJob,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class given cached content.
|
|
</summary>
|
|
<param name="tuningJob">Tuning Job to use with the model.</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="tuningJob"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.ListTunedModels(System.Nullable{System.Int32},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Get a list of available tuned models and description.
|
|
</summary>
|
|
<returns>List of available tuned models.</returns>
|
|
<param name="pageSize">The maximum number of Models to return (per page).</param>
|
|
<param name="pageToken">A page token, received from a previous ListModels call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</param>
|
|
<param name="filter">Optional. A filter is a full text search over the tuned model's description and display name. By default, results will not include tuned models shared with everyone. Additional operators: - owner:me - writers:me - readers:me - readers:everyone</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<exception cref="T:System.NotSupportedException"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.ListModels(System.Boolean,System.Nullable{System.Int32},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Lists the [`Model`s](https://ai.google.dev/gemini-api/docs/models/gemini) available through the Gemini API.
|
|
</summary>
|
|
<returns>List of available models.</returns>
|
|
<param name="tuned">Flag, whether models or tuned models shall be returned.</param>
|
|
<param name="pageSize">The maximum number of `Models` to return (per page). If unspecified, 50 models will be returned per page. This method returns at most 1000 models per page, even if you pass a larger page_size.</param>
|
|
<param name="pageToken">A page token, received from a previous ListModels call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</param>
|
|
<param name="filter">Optional. A filter is a full text search over the tuned model's description and display name. By default, results will not include tuned models shared with everyone. Additional operators: - owner:me - writers:me - readers:me - readers:everyone</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GetModel(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Gets information about a specific `Model` such as its version number, token limits, [parameters](https://ai.google.dev/gemini-api/docs/models/generative-models#model-parameters) and other metadata. Refer to the [Gemini models guide](https://ai.google.dev/gemini-api/docs/models/gemini) for detailed model information.
|
|
</summary>
|
|
<param name="model">Required. The resource name of the model. This name should match a model name returned by the ListModels method. Format: models/model-id or tunedModels/my-model-id</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CopyModel(Mscc.GenerativeAI.CopyModelRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Copies a model in Vertex AI Model Registry.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CreateTunedModel(Mscc.GenerativeAI.CreateTunedModelRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates a tuned model.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.DeleteTunedModel(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Deletes a tuned model.
|
|
</summary>
|
|
<param name="model">Required. The resource name of the model. Format: tunedModels/my-model-id</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>If successful, the response body is empty.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="model"/> is null or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.UpdateTunedModel(System.String,Mscc.GenerativeAI.ModelResponse,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Updates a tuned model.
|
|
</summary>
|
|
<param name="model">Required. The resource name of the model. Format: tunedModels/my-model-id</param>
|
|
<param name="tunedModel">The tuned model to update.</param>
|
|
<param name="updateMask">Optional. The list of fields to update. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="model"/> is null or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.TransferOwnership(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Transfers ownership of the tuned model. This is the only way to change ownership of the tuned model. The current owner will be downgraded to writer role.
|
|
</summary>
|
|
<param name="model">Required. The resource name of the tuned model to transfer ownership. Format: tunedModels/my-model-id</param>
|
|
<param name="emailAddress">Required. The email address of the user to whom the tuned model is being transferred to.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>If successful, the response body is empty.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="model"/> or <paramref name="emailAddress"/> is null or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.UploadFile(System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Uploads a file to the File API backend.
|
|
</summary>
|
|
<param name="uri">URI or path to the file to upload.</param>
|
|
<param name="displayName">A name displayed for the uploaded file.</param>
|
|
<param name="resumable">Flag indicating whether to use resumable upload.</param>
|
|
<param name="cancellationToken">A cancellation token to cancel the upload.</param>
|
|
<returns>A URI of the uploaded file.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="uri"/> is null or empty.</exception>
|
|
<exception cref="T:System.IO.FileNotFoundException">Thrown when the file <paramref name="uri"/> is not found.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.MaxUploadFileSizeException">Thrown when the file size exceeds the maximum allowed size.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.UploadFileException">Thrown when the file upload fails.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.UploadFile(System.IO.Stream,System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Uploads a stream to the File API backend.
|
|
</summary>
|
|
<param name="stream">Stream to upload.</param>
|
|
<param name="displayName">A name displayed for the uploaded file.</param>
|
|
<param name="mimeType">The MIME type of the stream content.</param>
|
|
<param name="resumable">Flag indicating whether to use resumable upload.</param>
|
|
<param name="cancellationToken">A cancellation token to cancel the upload.</param>
|
|
<returns>A URI of the uploaded file.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="stream"/> is null or empty.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.MaxUploadFileSizeException">Thrown when the <paramref name="stream"/> size exceeds the maximum allowed size.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.UploadFileException">Thrown when the <paramref name="stream"/> upload fails.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.ListFiles(System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Lists the metadata for Files owned by the requesting project.
|
|
</summary>
|
|
<param name="pageSize">The maximum number of Models to return (per page).</param>
|
|
<param name="pageToken">A page token, received from a previous ListFiles call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List of files in File API.</returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GetFile(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Gets the metadata for the given File.
|
|
</summary>
|
|
<param name="file">Required. The resource name of the file to get. This name should match a file name returned by the ListFiles method. Format: files/file-id.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Metadata for the given file.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is null or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.DeleteFile(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Deletes a file.
|
|
</summary>
|
|
<param name="file">Required. The resource name of the file to get. This name should match a file name returned by the ListFiles method. Format: files/file-id.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>If successful, the response body is empty.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is null or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContent(Mscc.GenerativeAI.GenerateContentRequest,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a model response given an input <see cref="T:Mscc.GenerativeAI.GenerateContentRequest"/>.
|
|
</summary>
|
|
<remarks>
|
|
Refer to the [text generation guide](https://ai.google.dev/gemini-api/docs/text-generation) for detailed usage information.
|
|
Input capabilities differ between models, including tuned models.
|
|
Refer to the [model guide](https://ai.google.dev/gemini-api/docs/models/gemini) and [tuning guide](https://ai.google.dev/gemini-api/docs/model-tuning) for details.
|
|
</remarks>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model or combination of features.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContent(System.String,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.ToolConfig,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a response from the model given an input prompt and other parameters.
|
|
</summary>
|
|
<param name="prompt">Required. String to process.</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="tools">Optional. A list of Tools the model may use to generate the next response.</param>
|
|
<param name="toolConfig">Optional. Configuration of tools.</param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContent(System.Collections.Generic.List{Mscc.GenerativeAI.IPart},Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.ToolConfig,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContentStream(Mscc.GenerativeAI.GenerateContentRequest,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a streamed response from the model given an input GenerateContentRequest.
|
|
This method uses a MemoryStream and StreamContent to send a streaming request to the API.
|
|
It runs asynchronously sending and receiving chunks to and from the API endpoint, which allows non-blocking code execution.
|
|
</summary>
|
|
<param name="request">The request to send to the API.</param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>Stream of GenerateContentResponse with chunks asynchronously.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model or combination of features.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContentStream(System.String,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.ToolConfig,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContentStream(System.Collections.Generic.List{Mscc.GenerativeAI.IPart},Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.ToolConfig,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContentStreamSSE(Mscc.GenerativeAI.GenerateContentRequest,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a response from the model given an input GenerateContentRequest.
|
|
</summary>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.BidiGenerateContent">
|
|
<summary>
|
|
|
|
</summary>
|
|
<returns></returns>
|
|
<exception cref="T:System.NotSupportedException"></exception>
|
|
<exception cref="T:System.NotImplementedException"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateImages(Mscc.GenerativeAI.GenerateImagesRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateImages(System.String,System.String,Mscc.GenerativeAI.GenerateImagesConfig,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates images from text prompt.
|
|
</summary>
|
|
<param name="model">Required. Model to use.</param>
|
|
<param name="prompt">Required. String to process.</param>
|
|
<param name="config">Configuration of image generation.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="model"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateImages(System.String,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates images from text prompt.
|
|
</summary>
|
|
<param name="prompt">Required. String to process.</param>
|
|
<param name="numberOfImages">Number of images to generate. Range: 1..8.</param>
|
|
<param name="negativePrompt">A description of what you want to omit in the generated images.</param>
|
|
<param name="aspectRatio">Aspect ratio for the image.</param>
|
|
<param name="guidanceScale">Controls the strength of the prompt. Suggested values are - * 0-9 (low strength) * 10-20 (medium strength) * 21+ (high strength)</param>
|
|
<param name="language">Language of the text prompt for the image.</param>
|
|
<param name="safetyFilterLevel">Adds a filter level to Safety filtering.</param>
|
|
<param name="personGeneration">Allow generation of people by the model.</param>
|
|
<param name="enhancePrompt">Option to enhance your provided prompt.</param>
|
|
<param name="addWatermark">Explicitly set the watermark</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateAnswer(Mscc.GenerativeAI.GenerateAnswerRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a grounded answer from the model given an input GenerateAnswerRequest.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for a grounded answer.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateAnswer(System.String,System.Nullable{Mscc.GenerativeAI.AnswerStyle},System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedContent(Mscc.GenerativeAI.EmbedContentRequest,System.String,System.Nullable{Mscc.GenerativeAI.TaskType},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a text embedding vector from the input `Content` using the specified [Gemini Embedding model](https://ai.google.dev/gemini-api/docs/models/gemini#text-embedding).
|
|
</summary>
|
|
<param name="request">Required. EmbedContentRequest to process. The content to embed. Only the parts.text fields will be counted.</param>
|
|
<param name="model">Optional. The model used to generate embeddings. Defaults to models/embedding-001.</param>
|
|
<param name="taskType">Optional. Optional task type for which the embeddings will be used. Can only be set for models/embedding-001.</param>
|
|
<param name="title">Optional. An optional title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT. Note: Specifying a title for RETRIEVAL_DOCUMENT provides better quality embeddings for retrieval.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List containing the embedding (list of float values) for the input content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedContent(System.Collections.Generic.List{Mscc.GenerativeAI.EmbedContentRequest},System.String,System.Nullable{Mscc.GenerativeAI.TaskType},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates multiple embedding vectors from the input `Content` which consists of a batch of strings represented as `EmbedContentRequest` objects.
|
|
</summary>
|
|
<param name="requests">Required. Embed requests for the batch. The model in each of these requests must match the model specified BatchEmbedContentsRequest.model.</param>
|
|
<param name="model">Optional. The model used to generate embeddings. Defaults to models/embedding-001.</param>
|
|
<param name="taskType">Optional. Optional task type for which the embeddings will be used. Can only be set for models/embedding-001.</param>
|
|
<param name="title">Optional. An optional title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT. Note: Specifying a title for RETRIEVAL_DOCUMENT provides better quality embeddings for retrieval.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List containing the embedding (list of float values) for the input content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="requests"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedContent(System.String,System.String,System.Nullable{Mscc.GenerativeAI.TaskType},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates an embedding from the model given an input Content.
|
|
</summary>
|
|
<param name="content">Required. String to process. The content to embed. Only the parts.text fields will be counted.</param>
|
|
<param name="model">Optional. The model used to generate embeddings. Defaults to models/embedding-001.</param>
|
|
<param name="taskType">Optional. Optional task type for which the embeddings will be used. Can only be set for models/embedding-001.</param>
|
|
<param name="title">Optional. An optional title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT. Note: Specifying a title for RETRIEVAL_DOCUMENT provides better quality embeddings for retrieval.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List containing the embedding (list of float values) for the input content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="content"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedContent(System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{Mscc.GenerativeAI.TaskType},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates an embedding from the model given an input Content.
|
|
</summary>
|
|
<param name="content">Required. List of strings to process. The content to embed. Only the parts.text fields will be counted.</param>
|
|
<param name="model">Optional. The model used to generate embeddings. Defaults to models/embedding-001.</param>
|
|
<param name="taskType">Optional. Optional task type for which the embeddings will be used. Can only be set for models/embedding-001.</param>
|
|
<param name="title">Optional. An optional title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT. Note: Specifying a title for RETRIEVAL_DOCUMENT provides better quality embeddings for retrieval.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List containing the embedding (list of float values) for the input content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="content"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedContent(Mscc.GenerativeAI.ContentResponse,System.String,System.Nullable{Mscc.GenerativeAI.TaskType},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates multiple embeddings from the model given input text in a synchronous call.
|
|
</summary>
|
|
<param name="content">Content to embed.</param>
|
|
<param name="model">Optional. The model used to generate embeddings. Defaults to models/embedding-001.</param>
|
|
<param name="taskType">Optional. Optional task type for which the embeddings will be used. Can only be set for models/embedding-001.</param>
|
|
<param name="title">Optional. An optional title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT. Note: Specifying a title for RETRIEVAL_DOCUMENT provides better quality embeddings for retrieval.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List containing the embedding (list of float values) for the input content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="content"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.GenerateContentRequest,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Runs a model's tokenizer on input `Content` and returns the token count.
|
|
</summary>
|
|
<remarks>
|
|
Refer to the [tokens guide](https://ai.google.dev/gemini-api/docs/tokens) to learn more about tokens.
|
|
</remarks>
|
|
<param name="request"></param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Number of tokens.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(System.String,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(System.Collections.Generic.List{Mscc.GenerativeAI.IPart},System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.StartChat(System.Collections.Generic.List{Mscc.GenerativeAI.ContentResponse},Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},System.Boolean)">
|
|
<summary>
|
|
Starts a chat session.
|
|
</summary>
|
|
<param name="history">Optional. A collection of <see cref="T:Mscc.GenerativeAI.ContentResponse"/> objects, or equivalents to initialize the session.</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="tools">Optional. A list of Tools the model may use to generate the next response.</param>
|
|
<param name="enableAutomaticFunctionCalling"></param>
|
|
<returns>Returns a <see cref="T:Mscc.GenerativeAI.ChatSession"/> attached to this model.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.Predict(Mscc.GenerativeAI.PredictRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Performs a prediction request.
|
|
</summary>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Prediction response.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.PredictLongRunning(Mscc.GenerativeAI.PredictLongRunningRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Same as Predict but returns an LRO.
|
|
</summary>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Prediction response.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateText(Mscc.GenerativeAI.GenerateTextRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a response from the model given an input message.
|
|
</summary>
|
|
<param name="request">The request to send to the API.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateText(System.String,System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.GenerateTextRequest,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Counts the number of tokens in the content.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Number of tokens.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateMessage(Mscc.GenerativeAI.GenerateMessageRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a response from the model given an input prompt.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateMessage(System.String,System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.GenerateMessageRequest,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Runs a model's tokenizer on a string and returns the token count.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Number of tokens.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedText(Mscc.GenerativeAI.EmbedTextRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException"></exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedText(System.String,System.Threading.CancellationToken)">
|
|
<remarks/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.EmbedTextRequest,Mscc.GenerativeAI.RequestOptions,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Counts the number of tokens in the content.
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="requestOptions">Options for the request.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Number of tokens.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GenerativeModel.BatchEmbedText(Mscc.GenerativeAI.BatchEmbedTextRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates multiple embeddings from the model given input text in a synchronous call.
|
|
</summary>
|
|
<param name="request">Required. Embed requests for the batch. The model in each of these requests must match the model specified BatchEmbedContentsRequest.model.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>List of Embeddings of the content as a list of floating numbers.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.NotSupportedException"></exception>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.GoogleAI">
|
|
<summary>
|
|
Entry point to access Gemini API running in Google AI.
|
|
</summary>
|
|
<remarks>
|
|
See <a href="https://ai.google.dev/api/rest">Model reference</a>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GoogleAI"/> class with access to Google AI Gemini API.
|
|
The default constructor attempts to read <c>.env</c> file and environment variables.
|
|
Sets default values, if available.
|
|
</summary>
|
|
<remarks>The following environment variables are used:
|
|
<list type="table">
|
|
<item><term>GOOGLE_API_KEY</term>
|
|
<description>API key provided by Google AI Studio.</description></item>
|
|
<item><term>GOOGLE_ACCESS_TOKEN</term>
|
|
<description>Optional. Access token provided by OAuth 2.0 or Application Default Credentials (ADC).</description></item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GoogleAI"/> class with access to Google AI Gemini API.
|
|
Either API key or access token is required.
|
|
</summary>
|
|
<param name="apiKey">API key for Google AI Studio.</param>
|
|
<param name="accessToken">Access token for the Google Cloud project.</param>
|
|
<param name="apiVersion">Version of the API.</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.GenerativeModel(System.String,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.Content)">
|
|
<summary>
|
|
Create a generative model on Google AI to use.
|
|
</summary>
|
|
<param name="model">Model to use (default: "gemini-1.5-pro")</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="tools">Optional. A list of Tools the model may use to generate the next response.</param>
|
|
<param name="systemInstruction">Optional. </param>
|
|
<returns>Generative model instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when both "apiKey" and "accessToken" are <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.GenerativeModel(Mscc.GenerativeAI.CachedContent,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting})">
|
|
<summary>
|
|
Create a generative model on Google AI to use.
|
|
</summary>
|
|
<param name="cachedContent">Content that has been preprocessed.</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<returns>Generative model instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="cachedContent"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when both "apiKey" and "accessToken" are <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.GetModel(System.String)">
|
|
<inheritdoc cref="T:Mscc.GenerativeAI.IGenerativeAI"/>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.CachedContent">
|
|
<summary>
|
|
Returns an instance of CachedContent to use with a model.
|
|
</summary>
|
|
<returns>Cached content instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when both "apiKey" and "accessToken" are <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.ImageGenerationModel(System.String)">
|
|
<summary>
|
|
Returns an instance of <see cref="M:Mscc.GenerativeAI.GoogleAI.ImageGenerationModel(System.String)"/> to use with a model.
|
|
</summary>
|
|
<param name="model">Model to use (default: "imagegeneration")</param>
|
|
<returns>Imagen model</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when both "apiKey" and "accessToken" are <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.UploadFile(System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Uploads a file to the File API backend.
|
|
</summary>
|
|
<param name="uri">URI or path to the file to upload.</param>
|
|
<param name="displayName">A name displayed for the uploaded file.</param>
|
|
<param name="resumable">Flag indicating whether to use resumable upload.</param>
|
|
<param name="cancellationToken">A cancellation token to cancel the upload.</param>
|
|
<returns>A URI of the uploaded file.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="uri"/> is null or empty.</exception>
|
|
<exception cref="T:System.IO.FileNotFoundException">Thrown when the file <paramref name="uri"/> is not found.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.MaxUploadFileSizeException">Thrown when the file size exceeds the maximum allowed size.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.UploadFileException">Thrown when the file upload fails.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.UploadFile(System.IO.Stream,System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Uploads a stream to the File API backend.
|
|
</summary>
|
|
<param name="stream">Stream to upload.</param>
|
|
<param name="displayName">A name displayed for the uploaded file.</param>
|
|
<param name="mimeType">The MIME type of the stream content.</param>
|
|
<param name="resumable">Flag indicating whether to use resumable upload.</param>
|
|
<param name="cancellationToken">A cancellation token to cancel the upload.</param>
|
|
<returns>A URI of the uploaded file.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="stream"/> is null or empty.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.MaxUploadFileSizeException">Thrown when the <paramref name="stream"/> size exceeds the maximum allowed size.</exception>
|
|
<exception cref="T:Mscc.GenerativeAI.UploadFileException">Thrown when the <paramref name="stream"/> upload fails.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.DownloadFile(System.String)">
|
|
<summary>
|
|
Gets a generated file.
|
|
</summary>
|
|
<remarks>
|
|
When calling this method via REST, only the metadata of the generated file is returned.
|
|
To retrieve the file content via REST, add alt=media as a query parameter.
|
|
</remarks>
|
|
<param name="file">Required. The name of the generated file to retrieve. Example: `generatedFiles/abc-123`</param>
|
|
<returns>Metadata for the given file.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is null or empty.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.ListFiles(System.Nullable{System.Int32},System.String)">
|
|
<summary>
|
|
Lists the metadata for Files owned by the requesting project.
|
|
</summary>
|
|
<param name="pageSize">The maximum number of Models to return (per page).</param>
|
|
<param name="pageToken">A page token, received from a previous files.list call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</param>
|
|
<returns>List of files in File API.</returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.GetFile(System.String)">
|
|
<summary>
|
|
Gets the metadata for the given File.
|
|
</summary>
|
|
<param name="file">Required. The resource name of the file to get. This name should match a file name returned by the files.list method. Format: files/file-id.</param>
|
|
<returns>Metadata for the given file.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is null or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.DeleteFile(System.String)">
|
|
<summary>
|
|
Deletes a file.
|
|
</summary>
|
|
<param name="file">Required. The resource name of the file to get. This name should match a file name returned by the files.list method. Format: files/file-id.</param>
|
|
<returns>If successful, the response body is empty.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is null or empty.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.GoogleAI.ListGeneratedFiles(System.Nullable{System.Int32},System.String)">
|
|
<summary>
|
|
Lists the metadata for Files owned by the requesting project.
|
|
</summary>
|
|
<param name="pageSize">The maximum number of Models to return (per page).</param>
|
|
<param name="pageToken">A page token, received from a previous files.list call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</param>
|
|
<returns>List of files in File API.</returns>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the functionality is not supported by the model.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.IGenerativeAI">
|
|
<summary>
|
|
The interface shall be used to write generic implementations using either
|
|
Google AI Gemini API or Vertex AI Gemini API as backends.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.IGenerativeAI.GenerativeModel(System.String,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting},System.Collections.Generic.List{Mscc.GenerativeAI.Tool},Mscc.GenerativeAI.Content)">
|
|
<summary>
|
|
Create an instance of a generative model to use.
|
|
</summary>
|
|
<param name="model">Model to use (default: "gemini-1.5-pro")</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<param name="tools">Optional. A list of Tools the model may use to generate the next response.</param>
|
|
<param name="systemInstruction">Optional. </param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when required parameters are null.</exception>
|
|
<returns>Generative model instance.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.IGenerativeAI.GenerativeModel(Mscc.GenerativeAI.CachedContent,Mscc.GenerativeAI.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.SafetySetting})">
|
|
<summary>
|
|
Create an instance of a generative model to use.
|
|
</summary>
|
|
<param name="cachedContent">Content that has been preprocessed.</param>
|
|
<param name="generationConfig">Optional. Configuration options for model generation and outputs.</param>
|
|
<param name="safetySettings">Optional. A list of unique SafetySetting instances for blocking unsafe content.</param>
|
|
<returns>Generative model instance.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.IGenerativeAI.GetModel(System.String)">
|
|
<summary>
|
|
Gets information about a specific Model.
|
|
</summary>
|
|
<param name="model">Required. The resource name of the model. This name should match a model name returned by the models.list method. Format: models/model-id or tunedModels/my-model-id</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when model parameter is null.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the backend does not support this method or the model.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.IGenerativeAI.ImageGenerationModel(System.String)">
|
|
<summary>
|
|
Returns an instance of an image generation model.
|
|
</summary>
|
|
<param name="model">Model to use (default: "imagegeneration")</param>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.ImageGenerationModel">
|
|
<summary>
|
|
Name of the model that supports image generation.
|
|
The <see cref="T:Mscc.GenerativeAI.ImageGenerationModel"/> can create high quality visual assets in seconds and brings Google's state-of-the-art vision and multimodal generative AI capabilities to application developers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImageGenerationModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImageGenerationModel"/> class.
|
|
The default constructor attempts to read <c>.env</c> file and environment variables.
|
|
Sets default values, if available.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.#ctor(System.String,System.String,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImageGenerationModel"/> class with access to Google AI Gemini API.
|
|
</summary>
|
|
<param name="apiKey">API key provided by Google AI Studio</param>
|
|
<param name="model">Model to use</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImageGenerationModel"/> class with access to Vertex AI Gemini API.
|
|
</summary>
|
|
<param name="projectId">Identifier of the Google Cloud project</param>
|
|
<param name="region">Region to use</param>
|
|
<param name="model">Model to use</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.GenerateImages(Mscc.GenerativeAI.ImageGenerationRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates images from the specified <see cref="T:Mscc.GenerativeAI.ImageGenerationRequest"/>.
|
|
</summary>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated images.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.GenerateImages(System.String,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates images from text prompt.
|
|
</summary>
|
|
<param name="prompt">Required. String to process.</param>
|
|
<param name="numberOfImages">Number of images to generate. Range: 1..8.</param>
|
|
<param name="negativePrompt">A description of what you want to omit in the generated images.</param>
|
|
<param name="aspectRatio">Aspect ratio for the image.</param>
|
|
<param name="guidanceScale">Controls the strength of the prompt. Suggested values are - * 0-9 (low strength) * 10-20 (medium strength) * 21+ (high strength)</param>
|
|
<param name="language">Language of the text prompt for the image.</param>
|
|
<param name="safetyFilterLevel">Adds a filter level to Safety filtering.</param>
|
|
<param name="personGeneration">Allow generation of people by the model.</param>
|
|
<param name="enhancePrompt">Option to enhance your provided prompt.</param>
|
|
<param name="addWatermark">Explicitly set the watermark</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.GenerateContent(System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a response from the model given an input prompt and other parameters.
|
|
</summary>
|
|
<param name="prompt">Required. String to process.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.ImagesModel">
|
|
<summary>
|
|
Generates an image from the model given an input.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImagesModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImagesModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImagesModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImagesModel"/> class.
|
|
</summary>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImagesModel.Images(Mscc.GenerativeAI.GenerateImagesRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="request"></param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentNullException"></exception>
|
|
</member>
|
|
<member name="T:Mscc.GenerativeAI.ImageTextModel">
|
|
<summary>
|
|
Name of the model that supports image captioning.
|
|
<see cref="T:Mscc.GenerativeAI.ImageTextModel"/> generates a caption from an image you provide based on the language that you specify. The model supports the following languages: English (en), German (de), French (fr), Spanish (es) and Italian (it).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageTextModel.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImageTextModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageTextModel.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImageTextModel"/> class.
|
|
The default constructor attempts to read <c>.env</c> file and environment variables.
|
|
Sets default values, if available.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageTextModel.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImageTextModel"/> class with access to Vertex AI Gemini API.
|
|
</summary>
|
|
<param name="projectId">Identifier of the Google Cloud project</param>
|
|
<param name="region">Region to use</param>
|
|
<param name="model">Model to use</param>
|
|
<param name="logger">Optional. Logger instance used for logging</param>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageTextModel.GetCaptions(Mscc.GenerativeAI.ImageTextRequest,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates images from the specified <see cref="T:Mscc.GenerativeAI.ImageTextRequest"/>.
|
|
</summary>
|
|
<param name="request">Required. The request to send to the API.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated images.</returns>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageTextModel.GetCaptions(System.String,System.Nullable{System.Int32},System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a response from the model given an input prompt and other parameters.
|
|
</summary>
|
|
<param name="base64Image">Required. The base64 encoded image to process.</param>
|
|
<param name="numberOfResults">Optional. Number of results to return. Default is 1.</param>
|
|
<param name="language">Optional. Language to use. Default is en.</param>
|
|
<param name="storageUri">Optional. Cloud Storage uri where to store the generated predictions.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
|
<returns>Response from the model for generated content.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="base64Image"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
|
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="language"/> is not supported by the API.</exception>
|
|
</member>
|
|
<member name="M:Mscc.GenerativeAI.ImageTextModel.AskQuestion(System.String,System.String,System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Generates a response from the model given an input prompt and other parameters.
|
|
</summary>
|
|
<param name="base64Image">Required. The base64 encoded image to process.</param>
|
|
<param name="question">Required. The question to ask about the image.</param>
|
|
<param name="numberOfResults">Optional. Number of results to return. Default is 1.</param>
|
|
<param name="language">Optional. Language to use. Default is en.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation |