19898 lines
1.1 MiB
Executable File
19898 lines
1.1 MiB
Executable File
<?xml version="1.0"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>Mscc.GenerativeAI</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="T:Mscc.GenerativeAI.BaseModel">
|
||
<summary>
|
||
The base class for all models, providing common functionality for API communication.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.BaseModel.BaseUrlGoogleAi">
|
||
<summary>
|
||
The base URL for the Google AI API.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.BaseModel.BaseUrlVertexAi">
|
||
<summary>
|
||
The base URL for the Vertex AI API.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.BaseModel.BaseUrlVertexAiGlobal">
|
||
<summary>
|
||
The base URL for the Vertex AI API for global locations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.BaseModel.Client">
|
||
<summary>
|
||
Gets the <see cref="T:System.Net.Http.HttpClient"/> instance used for making API requests.
|
||
If an <see cref="T:System.Net.Http.IHttpClientFactory"/> is available, it is used to create the client; otherwise, a default client is created.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.CreateDefaultHttpClient">
|
||
<summary>
|
||
Creates a default <see cref="T:System.Net.Http.HttpClient"/> with appropriate settings for the target framework.
|
||
</summary>
|
||
<returns>A new <see cref="T:System.Net.Http.HttpClient"/> instance.</returns>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.BaseModel.Version">
|
||
<summary>
|
||
Gets or sets the API version to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.BaseModel.RequestOptions">
|
||
<summary>
|
||
Gets or sets the request options for API calls.
|
||
</summary>
|
||
</member>
|
||
<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>
|
||
Adds the API key to the request header if it is available.
|
||
</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>
|
||
Gets or sets the region to use for the request.
|
||
This is used in Vertex AI requests.
|
||
The default value is "us-central1".
|
||
</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>
|
||
A hook to verify if a specific request is supported by the current model configuration.
|
||
Throws a <see cref="T:System.NotSupportedException"/> if the functionality is not supported.
|
||
</summary>
|
||
<typeparam name="T">The type of the request object.</typeparam>
|
||
<param name="request">The request to verify.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger,Mscc.GenerativeAI.Types.RequestOptions)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BaseModel"/> class, primarily for Google AI.
|
||
It configures the model using an API key and environment variables.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<param name="requestOptions">Optional. Provides options for API requests.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.#ctor(System.String,System.String,System.String,System.String,System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger,Mscc.GenerativeAI.Types.RequestOptions)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BaseModel"/> class, primarily for Vertex AI.
|
||
It configures the model using a project ID, region, and access token.
|
||
</summary>
|
||
<param name="projectId">The Google Cloud project ID.</param>
|
||
<param name="region">The Google Cloud region.</param>
|
||
<param name="model">The model name to use.</param>
|
||
<param name="accessToken">Optional. The access token for authentication.</param>
|
||
<param name="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<param name="requestOptions">Options for the request.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.#ctor(System.Net.Http.HttpMessageHandler,Microsoft.Extensions.Logging.ILogger,Mscc.GenerativeAI.Types.RequestOptions)">
|
||
<summary>
|
||
Internal constructor for testing purposes, allows injecting a custom HttpMessageHandler.
|
||
</summary>
|
||
<param name="handler">The <see cref="T:System.Net.Http.HttpMessageHandler"/> to use for HTTP requests.</param>
|
||
<param name="logger">Optional. Logger instance used for logging.</param>
|
||
<param name="requestOptions">Optional. Provides options for API requests.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.ParseUrl(System.String,System.String)">
|
||
<summary>
|
||
Parses the URL template and replaces placeholders with their current values.
|
||
This method supports templates for both Google AI and Vertex AI endpoints.
|
||
</summary>
|
||
<param name="url">The URL template to parse (e.g., <see cref="F:Mscc.GenerativeAI.BaseModel.BaseUrlGoogleAi"/>).</param>
|
||
<param name="method">The specific API method to append to the URL (e.g., ":generateContent").</param>
|
||
<returns>The fully resolved URL with all placeholders replaced.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.Serialize``1(``0)">
|
||
<summary>
|
||
Serializes the request payload to a JSON string.
|
||
</summary>
|
||
<typeparam name="T">The type of the request object.</typeparam>
|
||
<param name="request">The request object to serialize.</param>
|
||
<returns>A JSON string representing the request.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.Deserialize``1(System.Net.Http.HttpResponseMessage)">
|
||
<summary>
|
||
Deserializes the JSON response from an API call into an object.
|
||
</summary>
|
||
<typeparam name="T">The type to deserialize the response into.</typeparam>
|
||
<param name="response">The <see cref="T:System.Net.Http.HttpResponseMessage"/> from the API call.</param>
|
||
<returns>A task that resolves to an instance of type <typeparamref name="T"/>.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.ReadJsonSerializerOptions">
|
||
<summary>
|
||
Configures and returns the default <see cref="T:System.Text.Json.JsonSerializerOptions"/> for deserialization.
|
||
</summary>
|
||
<returns>Default options for JSON deserialization.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.AddSnakeCaseAlias(System.Text.Json.Serialization.Metadata.JsonTypeInfo)">
|
||
<summary>
|
||
A <see cref="T:System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver"/> modifier that adds a snake_case alias for each property.
|
||
This allows deserialization to work with both camelCase and snake_case property names.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.WriteJsonSerializerOptions">
|
||
<summary>
|
||
Configures and returns the default <see cref="T:System.Text.Json.JsonSerializerOptions"/> for serialization.
|
||
</summary>
|
||
<returns>Default options for JSON serialization.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.GetCredentialsFromFile(System.String)">
|
||
<summary>
|
||
Reads credentials from a specified JSON file.
|
||
</summary>
|
||
<remarks>This is typically used for reading service account credentials from Google Cloud Platform.</remarks>
|
||
<param name="credentialsFile">The path to the credentials file.</param>
|
||
<returns>A <see cref="T:Mscc.GenerativeAI.Types.Credentials"/> object if the file exists and is valid; otherwise, <c>null</c>.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.GetAccessTokenFromAdc">
|
||
<summary>
|
||
Retrieves an access token from Application Default Credentials (ADC) using the gcloud command-line tool.
|
||
This method is specific to Google Cloud Platform.
|
||
</summary>
|
||
<returns>The access token as a string, or an empty string if it fails.</returns>
|
||
<seealso href="https://cloud.google.com/docs/authentication"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.RunExternalExe(System.String,System.String)">
|
||
<summary>
|
||
Executes an external command-line application.
|
||
</summary>
|
||
<param name="filename">The command or application to run.</param>
|
||
<param name="arguments">Optional arguments to pass to the application.</param>
|
||
<returns>The standard output from the application.</returns>
|
||
<exception cref="T:System.Exception">Thrown if the process exits with a non-zero code.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.Format(System.String,System.String)">
|
||
<summary>
|
||
Formats a command and its arguments for logging purposes.
|
||
</summary>
|
||
<param name="filename">The command or application that was run.</param>
|
||
<param name="arguments">The arguments passed to the application.</param>
|
||
<returns>A formatted string containing the command and arguments.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.PostAsync``2(``0,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Net.Http.HttpCompletionOption,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a POST request to the specified API endpoint and deserializes the response.
|
||
</summary>
|
||
<typeparam name="TRequest">The type of the request object.</typeparam>
|
||
<typeparam name="TResponse">The type of the expected response object.</typeparam>
|
||
<param name="request">The request object to send.</param>
|
||
<param name="url">The URL template for the API endpoint.</param>
|
||
<param name="method">The specific API method to call.</param>
|
||
<param name="requestOptions">Optional. Options for the request, like timeout and retry settings.</param>
|
||
<param name="completionOption">Optional. Defines when the HTTP operation should complete.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>A task that represents the asynchronous operation. The task result contains the deserialized response.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown if the request is null.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.GeminiApiTimeoutException">Thrown if the HTTP response times out.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.PostStreamAsync``2(``0,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends a POST request to the specified API endpoint and streams the response.
|
||
</summary>
|
||
<remarks>
|
||
<seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events">Using Server-Sent Events</seealso>
|
||
</remarks>
|
||
<typeparam name="TRequest">The type of the request object.</typeparam>
|
||
<typeparam name="TResponse">The type of the expected response objects in the stream.</typeparam>
|
||
<param name="request">The request object to send.</param>
|
||
<param name="url">The URL template for the API endpoint.</param>
|
||
<param name="method">The specific API method to call.</param>
|
||
<param name="requestOptions">Optional. Options for the request, like timeout and retry settings.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>An asynchronous stream of response objects.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown if the request is null.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.SendAsync(System.Net.Http.HttpRequestMessage,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken,System.Net.Http.HttpCompletionOption)">
|
||
<summary>
|
||
Sends an HTTP request and returns the response.
|
||
It handles adding authentication headers, user-agent, and custom headers.
|
||
It also implements a retry mechanism for transient failures.
|
||
</summary>
|
||
<param name="request">The <see cref="T:System.Net.Http.HttpRequestMessage"/> to send.</param>
|
||
<param name="requestOptions">Optional. Options for the request, including timeout and retry settings.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<param name="completionOption">Defines when the operation should complete.</param>
|
||
<returns>The <see cref="T:System.Net.Http.HttpResponseMessage"/> from the API.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.TruncateJsonForLogging(System.String)">
|
||
<summary>
|
||
Truncates the base64 data in the log to avoid blowing up the log file.
|
||
</summary>
|
||
<param name="json">The JSON string to sanitize.</param>
|
||
<returns>The sanitized JSON string.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.GetResponseMessageAsync(System.Net.Http.HttpResponseMessage,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously reads the content of an <see cref="T:System.Net.Http.HttpResponseMessage"/> as a string.
|
||
</summary>
|
||
<param name="response">The HTTP response.</param>
|
||
<param name="cancellationToken">A cancellation token.</param>
|
||
<returns>A task that represents the asynchronous operation. The task result contains the response content as a string.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.CloneHttpRequestMessageAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a deep clone of an <see cref="T:System.Net.Http.HttpRequestMessage"/>.
|
||
This is necessary for retrying requests, as a request message can only be sent once.
|
||
</summary>
|
||
<param name="request">The request to clone.</param>
|
||
<param name="cancellationToken">A cancellation token.</param>
|
||
<returns>A task that represents the asynchronous operation. The task result contains the cloned HTTP request message.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.Dispose">
|
||
<summary>
|
||
Disposes the <see cref="T:Mscc.GenerativeAI.BaseModel"/> and its underlying resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases the unmanaged resources used by the <see cref="T:Mscc.GenerativeAI.BaseModel"/> and optionally releases the managed resources.
|
||
</summary>
|
||
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BaseModel.DisposeAsync">
|
||
<summary>
|
||
Asynchronously disposes the <see cref="T:Mscc.GenerativeAI.BaseModel"/> and its underlying resources.
|
||
</summary>
|
||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> that represents the asynchronous dispose operation.</returns>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.BatchesModel">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BatchesModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.BatchesModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.List(System.String,System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Lists operations that match the specified filter in the request.
|
||
If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="filter">The standard list filter.</param>
|
||
<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="returnPartialSuccess">When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.Get(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest state of a long-running operation.
|
||
Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
||
</summary>
|
||
<param name="batchesName">Required. The name of the operation resource. Format: `batches/{id}`</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>The long-running operation resource.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="batchesName"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.Get``1(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest state of a long-running operation.
|
||
Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
||
</summary>
|
||
<param name="batchesName">Required. The name of the operation resource. Format: `batches/{id}`</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>The long-running operation resource.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="batchesName"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.Cancel(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Starts asynchronous cancellation on a long-running operation.
|
||
The server makes a best effort to cancel the operation, but success is not guaranteed.
|
||
If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||
Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded
|
||
or whether the operation completed despite cancellation. On successful cancellation, the operation is
|
||
not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`,
|
||
corresponding to `Code.CANCELLED`.
|
||
</summary>
|
||
<param name="batchesName">Required. The name of the operation resource. Format: `batches/{id}`</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>If successful, the response body is empty.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="batchesName"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.Delete(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes a long-running operation.
|
||
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||
</summary>
|
||
<param name="batchesName">Required. The name of the operation resource to be deleted. Format: `batches/{id}`</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>If successful, the response body is empty.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="batchesName"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.UpdateEmbedContentBatch(Mscc.GenerativeAI.Types.EmbedContentBatch,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates a batch of EmbedContent requests for batch processing.
|
||
</summary>
|
||
<param name="request">The batch resources to update</param>
|
||
<param name="batchesName">Required. The name of the operation resource to be deleted. Format: `batches/{id}`</param>
|
||
<param name="updateMask">Optional. The list of fields to update.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="batchesName"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.BatchesModel.UpdateGenerateContentBatch(Mscc.GenerativeAI.Types.GenerateContentBatch,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates a batch of GenerateContent requests for batch processing.
|
||
</summary>
|
||
<param name="request">The batch resources to update</param>
|
||
<param name="batchesName">Required. The name of the operation resource to be deleted. Format: `batches/{id}`</param>
|
||
<param name="updateMask">Optional. The list of fields to update.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="batchesName"/> is <see langword="null"/> or empty.</exception>
|
||
</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(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.CachedContentModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CachedContentModel.Create(Mscc.GenerativeAI.Types.CachedContent,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates CachedContent resource.
|
||
</summary>
|
||
<param name="request">The cached content resource to create.</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>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.Types.Content,System.Collections.Generic.List{Mscc.GenerativeAI.Types.Content},System.Collections.Generic.List{Mscc.GenerativeAI.Types.ContentResponse},System.Nullable{System.TimeSpan},System.Nullable{System.DateTime},Mscc.GenerativeAI.Types.RequestOptions,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="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>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,Mscc.GenerativeAI.Types.RequestOptions,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="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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CachedContentModel.Get(System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.CachedContent,System.TimeSpan,System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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="T:Mscc.GenerativeAI.ChatModel">
|
||
<summary>
|
||
The `ChatModel` class provides methods for interacting with a chat-based generative model.
|
||
</summary>
|
||
</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(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ChatModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ChatModel.Completions(Mscc.GenerativeAI.Types.ChatCompletionsRequest,Mscc.GenerativeAI.Types.RequestOptions,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="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>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ApiVersion">
|
||
<summary>
|
||
Helper class to provide API versions.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.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="T:Mscc.GenerativeAI.Types.Role">
|
||
<summary>
|
||
Possible roles.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.BlockedPromptException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:BlockedPromptException" /> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.BlockedPromptException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:BlockedPromptException" /> class
|
||
with a specific message that describes the current exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.BlockedPromptException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:BlockedPromptException" /> class
|
||
with a specific message that describes the current exception and an inner exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.BlockedPromptException.#ctor(Mscc.GenerativeAI.Types.PromptFeedback)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:BlockedPromptException" /> class
|
||
with the block reason message that describes the current exception.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GeminiApiException">
|
||
<summary>
|
||
Represents errors that occur during Generative AI API calls.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeminiApiException.Response">
|
||
<summary>
|
||
HTTP response from the API.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiException"/> class with a specified error message.
|
||
</summary>
|
||
<param name="message">The message that describes the error.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
||
</summary>
|
||
<param name="message">The error message that explains the reason for the exception.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiException.#ctor(System.String,System.Net.Http.HttpResponseMessage,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
||
</summary>
|
||
<param name="message">The error message that explains the reason for the exception.</param>
|
||
<param name="response">The HTTP response.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GeminiApiTimeoutException">
|
||
<summary>
|
||
Represents errors that occur during Generative AI API calls.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeminiApiTimeoutException.Response">
|
||
<summary>
|
||
HTTP response from the API.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiTimeoutException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiTimeoutException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiTimeoutException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiTimeoutException"/> class with a specified error message.
|
||
</summary>
|
||
<param name="message">The message that describes the error.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiTimeoutException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiTimeoutException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
||
</summary>
|
||
<param name="message">The error message that explains the reason for the exception.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GeminiApiTimeoutException.#ctor(System.String,System.Net.Http.HttpResponseMessage,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GeminiApiTimeoutException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
||
</summary>
|
||
<param name="message">The error message that explains the reason for the exception.</param>
|
||
<param name="response">The HTTP response.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.MaxUploadFileSizeException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MaxUploadFileSizeException" /> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.MaxUploadFileSizeException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MaxUploadFileSizeException" /> class
|
||
with a specific message that describes the current exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.MaxUploadFileSizeException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:MaxUploadFileSizeException" /> class
|
||
with a specific message that describes the current exception and an inner exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.UploadFileException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:UploadFileException" /> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.UploadFileException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:UploadFileException" /> class
|
||
with a specific message that describes the current exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.UploadFileException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:UploadFileException" /> class
|
||
with a specific message that describes the current exception and an inner exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ValueErrorException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:ValueErrorException" /> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ValueErrorException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:ValueErrorException" /> class
|
||
with a specific message that describes the current exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ValueErrorException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:ValueErrorException" /> class
|
||
with a specific message that describes the current exception and an inner exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.StopCandidateException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:StopCandidateException" /> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.StopCandidateException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:StopCandidateException" /> class
|
||
with a specific message that describes the current exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.StopCandidateException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:StopCandidateException" /> class
|
||
with a specific message that describes the current exception and an inner exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.StopCandidateException.#ctor(Mscc.GenerativeAI.Types.Candidate)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:StopCandidateException" /> class
|
||
with the finish message that describes the current exception.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerativeModelLogMessages">
|
||
<summary>
|
||
Extensions for logging <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> invocations.
|
||
</summary>
|
||
<remarks>
|
||
This extension uses the <see cref="T:Microsoft.Extensions.Logging.LoggerMessageAttribute"/> to
|
||
generate logging code at compile time to achieve optimized code.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogParsedRequest(Microsoft.Extensions.Logging.ILogger,System.Net.Http.HttpMethod,System.Uri,System.String,System.String)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.BaseModel"/> parsing the URL to call.
|
||
</summary>
|
||
<param name="logger">Logger instance used for logging</param>
|
||
<param name="method">HTTP method of the request.</param>
|
||
<param name="uri">Parsed URL.</param>
|
||
<param name="headers"></param>
|
||
<param name="content"></param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogMethodInvokingRequest(Microsoft.Extensions.Logging.ILogger,System.String)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> invoking an API request.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<param name="methodName">Calling method</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogGenerativeModelInvoking(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.GenerativeModel"/>
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogClientInvoking(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.Client"/>
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogLiveModelInvoking(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.LiveModel"/>
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogDynamicModelInvoking(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.DynamicModel"/>
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogGenerativeModelInvoked(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.GenerativeModel"/>
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogRunExternalExe(Microsoft.Extensions.Logging.ILogger,System.String)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.BaseModel"/> when exception thrown to run an external application.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<param name="message">Message of <see cref="T:System.Exception"/> to log.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogRequestNotSuccessful(Microsoft.Extensions.Logging.ILogger,System.Int32)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.BaseModel"/> when exception thrown.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<param name="index">Nth attempt of request sent.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogRequestNotSuccessful(Microsoft.Extensions.Logging.ILogger,System.Int32,System.String)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.BaseModel"/> when exception thrown.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<param name="index">Nth attempt of request sent.</param>
|
||
<param name="message">Message to log.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerativeModelLogMessages.LogRequestException(Microsoft.Extensions.Logging.ILogger,System.Int32,System.String)">
|
||
<summary>
|
||
Logs <see cref="T:Mscc.GenerativeAI.BaseModel"/> when exception thrown.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<param name="index">Nth attempt of request sent.</param>
|
||
<param name="message">Message to log.</param>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ActivityHandling">
|
||
<summary>
|
||
Defines what effect activity has.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ActivityHandling.ActivityHandlingUnspecified">
|
||
<summary>
|
||
If unspecified, the default behavior is `START_OF_ACTIVITY_INTERRUPTS`.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ActivityHandling.StartOfActivityInterrupts">
|
||
<summary>
|
||
If true, start of activity will interrupt the model's response (also called \"barge in\"). The model's current response will be cut-off in the moment of the interruption. This is the default behavior.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ActivityHandling.NoInterruption">
|
||
<summary>
|
||
The model's response will not be interrupted."
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AdapterSize.AdapterSizeUnspecified">
|
||
<summary>
|
||
Adapter size is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AdapterSize.AdapterSizeOne">
|
||
<summary>
|
||
Adapter size 1.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AdapterSize.AdapterSizeTwo">
|
||
<summary>
|
||
Adapter size 2.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AdapterSize.AdapterSizeFour">
|
||
<summary>
|
||
Adapter size 4.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AdapterSize.AdapterSizeEight">
|
||
<summary>
|
||
Adapter size 8.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AdapterSize.AdapterSizeSixteen">
|
||
<summary>
|
||
Adapter size 16.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AdapterSize.AdapterSizeThirtyTwo">
|
||
<summary>
|
||
Adapter size 32.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AggregationOutput">
|
||
<summary>
|
||
The aggregation result for the entire dataset and all metrics.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationOutput.AggregationResults">
|
||
<summary>
|
||
One AggregationResult per metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationOutput.Dataset">
|
||
<summary>
|
||
The dataset used for evaluation & aggregation.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AggregationResult">
|
||
<summary>
|
||
The aggregation result for a single metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetric">
|
||
<summary>
|
||
Aggregation metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationResult.BleuMetricValue">
|
||
<summary>
|
||
Results for bleu metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationResult.CustomCodeExecutionResult">
|
||
<summary>
|
||
Result for code execution metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationResult.ExactMatchMetricValue">
|
||
<summary>
|
||
Results for exact match metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationResult.PairwiseMetricResult">
|
||
<summary>
|
||
Result for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationResult.PointwiseMetricResult">
|
||
<summary>
|
||
Result for pointwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AggregationResult.RougeMetricValue">
|
||
<summary>
|
||
Results for rouge metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.AggregationMetricUnspecified">
|
||
<summary>
|
||
Unspecified aggregation metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.Average">
|
||
<summary>
|
||
Average aggregation metric. Not supported for Pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.Mode">
|
||
<summary>
|
||
Mode aggregation metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.StandardDeviation">
|
||
<summary>
|
||
Standard deviation aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.Variance">
|
||
<summary>
|
||
Variance aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.Minimum">
|
||
<summary>
|
||
Minimum aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.Maximum">
|
||
<summary>
|
||
Maximum aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.Median">
|
||
<summary>
|
||
Median aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.PercentileP90">
|
||
<summary>
|
||
90th percentile aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.PercentileP95">
|
||
<summary>
|
||
95th percentile aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AggregationResult.AggregationMetricType.PercentileP99">
|
||
<summary>
|
||
99th percentile aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AnswerStyle.AnswerStyleUnspecified">
|
||
<summary>
|
||
Unspecified answer style.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AnswerStyle.Abstractive">
|
||
<summary>
|
||
Succinct but abstract style.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AnswerStyle.Extractive">
|
||
<summary>
|
||
Very brief and extractive style.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.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.Types.ApiAuth">
|
||
<summary>
|
||
The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.
|
||
</summary>
|
||
<summary>
|
||
The generic reusable api auth config.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiAuth.ApiKeyConfig">
|
||
<summary>
|
||
The API secret.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ApiAuthApiKeyConfig">
|
||
<summary>
|
||
The API secret.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiAuthApiKeyConfig.ApiKeySecretVersion">
|
||
<summary>
|
||
Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiAuthApiKeyConfig.ApiKeyString">
|
||
<summary>
|
||
The API key string. Either this or <c>api_key_secret_version</c> must be set.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ApiKeyConfig">
|
||
<summary>
|
||
Config for authentication with API key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiKeyConfig.Name">
|
||
<summary>
|
||
Optional. The parameter name of the API key.
|
||
E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiKeyConfig.ApiKeySecret">
|
||
<summary>
|
||
Optional. The name of the SecretManager secret version resource storing the API key.
|
||
Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiKeyConfig.ApiKeyString">
|
||
<summary>
|
||
Optional. The API key to be used in the request directly.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiKeyConfig.HttpElementLocation">
|
||
<summary>
|
||
Optional. The location of the API key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ApiKeyConfig.ApiKeySecretVersion">
|
||
<summary>
|
||
Required. The SecretManager secret version resource name storing API key.
|
||
e.g. projects/{project}/secrets/{secret}/versions/{version}
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AsyncBatchEmbedContentRequest">
|
||
<summary>
|
||
Request for an <c>AsyncBatchEmbedContent</c> operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AsyncBatchEmbedContentRequest.Batch">
|
||
<summary>
|
||
Required. The batch to create.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.AsyncSession.Close">
|
||
<summary>
|
||
Closes the WebSocket connection gracefully. This method is thread-safe and idempotent.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.AsyncSession.DisposeAsync">
|
||
<summary>
|
||
Asynchronously disposes the session by closing the WebSocket connection.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AttributionSourceId">
|
||
<summary>
|
||
Identifier for the source contributing to this attribution.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AttributionSourceId.GroundingPassage">
|
||
<summary>
|
||
Identifier for an inline passage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AttributionSourceId.SemanticRetrieverChunk">
|
||
<summary>
|
||
Identifier for a <c>Chunk</c> fetched via Semantic Retriever.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AudioOptions">
|
||
<summary>
|
||
Options for audio generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AudioOptions.Format">
|
||
<summary>
|
||
Optional. The format of the audio response.
|
||
</summary>
|
||
<remarks>
|
||
Can be either:
|
||
- "wav": Format the response as a WAV file.
|
||
- "mp3": Format the response as an MP3 file.
|
||
- "flac": Format the response as a FLAC file.
|
||
- "opus": Format the response as an OPUS file.
|
||
- "pcm16": Format the response as a PCM16 file.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AudioOptions.Voice">
|
||
<summary>
|
||
Optional. The voice to use for the audio response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AudioTranscriptionConfig">
|
||
<summary>
|
||
The audio transcription configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AuthConfig">
|
||
<summary>
|
||
Auth configuration to run the extension.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfig.ApiKeyConfig">
|
||
<summary>
|
||
Config for API key auth.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfig.AuthType">
|
||
<summary>
|
||
Type of auth scheme.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfig.GoogleServiceAccountConfig">
|
||
<summary>
|
||
Config for Google Service Account auth.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfig.HttpBasicAuthConfig">
|
||
<summary>
|
||
Config for HTTP Basic auth.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfig.OauthConfig">
|
||
<summary>
|
||
Config for user oauth.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfig.OidcConfig">
|
||
<summary>
|
||
Config for user OIDC auth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AuthConfig.AuthConfigAuthType.NoAuth">
|
||
<summary>
|
||
No Auth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AuthConfig.AuthConfigAuthType.ApiKeyAuth">
|
||
<summary>
|
||
API Key Auth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AuthConfig.AuthConfigAuthType.HttpBasicAuth">
|
||
<summary>
|
||
HTTP Basic Auth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AuthConfig.AuthConfigAuthType.GoogleServiceAccountAuth">
|
||
<summary>
|
||
Google Service Account Auth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AuthConfig.AuthConfigAuthType.Oauth">
|
||
<summary>
|
||
OAuth auth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AuthConfig.AuthConfigAuthType.OidcAuth">
|
||
<summary>
|
||
OpenID Connect (OIDC) Auth.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AuthConfigApiKeyConfig">
|
||
<summary>
|
||
Config for authentication with API key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigApiKeyConfig.ApiKeySecret">
|
||
<summary>
|
||
Optional. The name of the SecretManager secret version resource storing the API key. Format: <c>projects/{project}/secrets/{secrete}/versions/{version}</c> - If both <c>api_key_secret</c> and <c>api_key_string</c> are specified, this field takes precedence over <c>api_key_string</c>. - If specified, the <c>secretmanager.versions.access</c> permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigApiKeyConfig.ApiKeyString">
|
||
<summary>
|
||
Optional. The API key to be used in the request directly.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigApiKeyConfig.HttpElementLocation">
|
||
<summary>
|
||
Optional. The location of the API key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigApiKeyConfig.Name">
|
||
<summary>
|
||
Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AuthConfigGoogleServiceAccountConfig">
|
||
<summary>
|
||
Config for Google Service Account Authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigGoogleServiceAccountConfig.ServiceAccount">
|
||
<summary>
|
||
Optional. The service account that the extension execution service runs as. - If the service account is specified, the <c>iam.serviceAccounts.getAccessToken</c> permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AuthConfigHttpBasicAuthConfig">
|
||
<summary>
|
||
Config for HTTP Basic Authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigHttpBasicAuthConfig.CredentialSecret">
|
||
<summary>
|
||
Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: <c>projects/{project}/secrets/{secrete}/versions/{version}</c> - If specified, the <c>secretmanager.versions.access</c> permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AuthConfigOauthConfig">
|
||
<summary>
|
||
Config for user oauth.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigOauthConfig.AccessToken">
|
||
<summary>
|
||
Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigOauthConfig.ServiceAccount">
|
||
<summary>
|
||
The service account used to generate access tokens for executing the Extension. - If the service account is specified, the <c>iam.serviceAccounts.getAccessToken</c> permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AuthConfigOidcConfig">
|
||
<summary>
|
||
Config for user OIDC auth.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigOidcConfig.IdToken">
|
||
<summary>
|
||
OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthConfigOidcConfig.ServiceAccount">
|
||
<summary>
|
||
The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant <c>iam.serviceAccounts.getOpenIdToken</c> permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AuthToken">
|
||
<summary>
|
||
A request to create an ephemeral authentication token.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthToken.BidiGenerateContentSetup">
|
||
<summary>
|
||
Optional. Input only. Immutable. Configuration specific to <c>BidiGenerateContent</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthToken.ExpireTime">
|
||
<summary>
|
||
Optional. Input only. Immutable. An optional time after which, when using the resulting token, messages in BidiGenerateContent sessions will be rejected. (Gemini may preemptively close the session after this time.) If not set then this defaults to 30 minutes in the future. If set, this value must be less than 20 hours in the future.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthToken.FieldMask">
|
||
<summary>
|
||
Optional. Input only. Immutable. If field_mask is empty, and <c>bidi_generate_content_setup</c> is not present, then the effective <c>BidiGenerateContentSetup</c> message is taken from the Live API connection. If field_mask is empty, and <c>bidi_generate_content_setup</c> _is_ present, then the effective <c>BidiGenerateContentSetup</c> message is taken entirely from <c>bidi_generate_content_setup</c> in this request. The setup message from the Live API connection is ignored. If field_mask is not empty, then the corresponding fields from <c>bidi_generate_content_setup</c> will overwrite the fields from the setup message in the Live API connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthToken.Name">
|
||
<summary>
|
||
Output only. Identifier. The token itself.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthToken.NewSessionExpireTime">
|
||
<summary>
|
||
Optional. Input only. Immutable. The time after which new Live API sessions using the token resulting from this request will be rejected. If not set this defaults to 60 seconds in the future. If set, this value must be less than 20 hours in the future.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AuthToken.Uses">
|
||
<summary>
|
||
Optional. Input only. Immutable. The number of times the token can be used. If this value is zero then no limit is applied. Resuming a Live API session does not count as a use. If unspecified, the default is 1.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AutomaticActivityDetection">
|
||
<summary>
|
||
Configures automatic detection of activity.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticActivityDetection.Disabled">
|
||
<summary>
|
||
Optional. If enabled (the default), detected voice and text input count as activity. If disabled, the client must send activity signals.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticActivityDetection.EndOfSpeechSensitivity">
|
||
<summary>
|
||
Optional. Determines how likely detected speech is ended.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticActivityDetection.PrefixPaddingMs">
|
||
<summary>
|
||
Optional. The required duration of detected speech before start-of-speech is committed. The lower this value, the more sensitive the start-of-speech detection is and shorter speech can be recognized. However, this also increases the probability of false positives.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticActivityDetection.SilenceDurationMs">
|
||
<summary>
|
||
Optional. The required duration of detected non-speech (e.g. silence) before end-of-speech is committed. The larger this value, the longer speech gaps can be without interrupting the user's activity but this will increase the model's latency.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticActivityDetection.StartOfSpeechSensitivity">
|
||
<summary>
|
||
Optional. Determines how likely speech is to be detected.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AutomaticActivityDetection.EndOfSpeechSensitivityType.EndSensitivityUnspecified">
|
||
<summary>
|
||
The default is END_SENSITIVITY_HIGH.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AutomaticActivityDetection.EndOfSpeechSensitivityType.EndSensitivityHigh">
|
||
<summary>
|
||
Automatic detection ends speech more often.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AutomaticActivityDetection.EndOfSpeechSensitivityType.EndSensitivityLow">
|
||
<summary>
|
||
Automatic detection ends speech less often.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AutomaticActivityDetection.StartOfSpeechSensitivityType.StartSensitivityUnspecified">
|
||
<summary>
|
||
The default is START_SENSITIVITY_HIGH.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AutomaticActivityDetection.StartOfSpeechSensitivityType.StartSensitivityHigh">
|
||
<summary>
|
||
Automatic detection will detect the start of speech more often.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.AutomaticActivityDetection.StartOfSpeechSensitivityType.StartSensitivityLow">
|
||
<summary>
|
||
Automatic detection will detect the start of speech less often.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AutomaticFunctionCallingConfig">
|
||
<summary>
|
||
The configuration for automatic function calling.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticFunctionCallingConfig.Disable">
|
||
<summary>
|
||
Whether to disable automatic function calling.
|
||
If not set or set to False, will enable automatic function calling.
|
||
If set to True, will disable automatic function calling.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticFunctionCallingConfig.IgnoreCallHistory">
|
||
<summary>
|
||
If automatic function calling is enabled, whether to ignore call history to the response.
|
||
If not set, SDK will set ignore_call_history to false, and will append the call history to
|
||
GenerateContentResponse.automatic_function_calling_history.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutomaticFunctionCallingConfig.MaximumRemoteCalls">
|
||
<summary>
|
||
If automatic function calling is enabled, maximum number of remote calls for automatic function calling.
|
||
This number should be a positive integer. If not set, SDK will set maximum number of remote calls to 10.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AutoraterConfig">
|
||
<summary>
|
||
The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutoraterConfig.AutoraterModel">
|
||
<summary>
|
||
Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: <c>projects/{project}/locations/{location}/publishers/*/models/*</c> Tuned model endpoint format: <c>projects/{project}/locations/{location}/endpoints/{endpoint}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutoraterConfig.FlipEnabled">
|
||
<summary>
|
||
Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutoraterConfig.GenerationConfig">
|
||
<summary>
|
||
Optional. Configuration options for model generation and outputs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutoraterConfig.SamplingCount">
|
||
<summary>
|
||
Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AutoRoutingMode">
|
||
<summary>
|
||
The configuration for automated routing. When automated routing is specified, the routing will
|
||
be determined by the pretrained routing model and customer provided model routing preference.
|
||
This data type is not supported in Gemini API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AutoRoutingMode.ModelRoutingPreference">
|
||
<summary>
|
||
The model routing preference.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BaseConfig">
|
||
<summary>
|
||
Abstract base class for many config types.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BaseConfig.HttpOptions">
|
||
<summary>
|
||
Used to override HTTP request options.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BaseConfig.IncludeRaiReason">
|
||
<summary>
|
||
Whether to include a reason for filtered-out images in the response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BaseLogger">
|
||
<summary>
|
||
Abstract base type with logging instance.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.BaseLogger.#ctor">
|
||
<summary>
|
||
Default constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.BaseLogger.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Base constructor to set the <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchCreateChunksRequest">
|
||
<summary>
|
||
Request to batch create <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchCreateChunksRequest.Requests">
|
||
<summary>
|
||
Required. The request messages specifying the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s to create. A maximum of 100 <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s can be created in a batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchCreateChunksResponse">
|
||
<summary>
|
||
Response from <see cref="!:BatchCreateChunks"/> containing a list of created <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchCreateChunksResponse.Chunks">
|
||
<summary>
|
||
<see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s created.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchDeleteChunksRequest">
|
||
<summary>
|
||
Request to batch delete <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchDeleteChunksRequest.Requests">
|
||
<summary>
|
||
Required. The request messages specifying the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s to delete.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchEmbedContentsRequest">
|
||
<summary>
|
||
Batch request to get embeddings from the model for a list of prompts.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchEmbedContentsRequest.Requests">
|
||
<summary>
|
||
Required. Embed requests for the batch. The model in each of these requests must match the model specified <c>BatchEmbedContentsRequest.model</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchEmbedContentsResponse">
|
||
<summary>
|
||
The response to a <c>BatchEmbedContentsRequest</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchEmbedContentsResponse.Embeddings">
|
||
<summary>
|
||
Output only. The embeddings for each request, in the same order as provided in the batch request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchEmbedTextRequest">
|
||
<summary>
|
||
Batch request to get a text embedding from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchEmbedTextRequest.Requests">
|
||
<summary>
|
||
Optional. Embed requests for the batch. Only one of <c>texts</c> or <c>requests</c> can be set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchEmbedTextRequest.Texts">
|
||
<summary>
|
||
Optional. The free-form input texts that the model will turn into an embedding. The current limit is 100 texts, over which an error will be thrown.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchEmbedTextResponse">
|
||
<summary>
|
||
The response to a EmbedTextRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchEmbedTextResponse.Embeddings">
|
||
<summary>
|
||
Output only. The embeddings generated from the input text.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchGenerateContentRequest">
|
||
<summary>
|
||
Request for a <c>BatchGenerateContent</c> operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchGenerateContentRequest.Batch">
|
||
<summary>
|
||
Required. The batch to create.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchStats">
|
||
<summary>
|
||
Stats about the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchStats.FailedRequestCount">
|
||
<summary>
|
||
Output only. The number of requests that failed to be processed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchStats.PendingRequestCount">
|
||
<summary>
|
||
Output only. The number of requests that are still pending processing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchStats.RequestCount">
|
||
<summary>
|
||
Output only. The number of requests in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchStats.SuccessfulRequestCount">
|
||
<summary>
|
||
Output only. The number of requests that were successfully processed.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchUpdateChunksRequest">
|
||
<summary>
|
||
Request to batch update <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchUpdateChunksRequest.Requests">
|
||
<summary>
|
||
Required. The request messages specifying the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s to update. A maximum of 100 <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s can be updated in a batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BatchUpdateChunksResponse">
|
||
<summary>
|
||
Response from <see cref="!:BatchUpdateChunks"/> containing a list of updated <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BatchUpdateChunksResponse.Chunks">
|
||
<summary>
|
||
<see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s updated.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BidiGenerateContentSetup">
|
||
<summary>
|
||
Message to be sent in the first (and only in the first) <c>BidiGenerateContentClientMessage</c>. Contains configuration that will apply for the duration of the streaming RPC. Clients should wait for a <c>BidiGenerateContentSetupComplete</c> message before sending any additional messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.ContextWindowCompression">
|
||
<summary>
|
||
Optional. Configures a context window compression mechanism. If included, the server will automatically reduce the size of the context when it exceeds the configured length.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.GenerationConfig">
|
||
<summary>
|
||
Optional. Generation config. The following fields are not supported: - <c>response_logprobs</c> - <c>response_mime_type</c> - <c>logprobs</c> - <c>response_schema</c> - <c>response_json_schema</c> - <c>stop_sequence</c> - <c>skip_response_cache</c> - <c>routing_config</c> - <c>audio_timestamp</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.InputAudioTranscription">
|
||
<summary>
|
||
Optional. If set, enables transcription of voice input. The transcription aligns with the input audio language, if configured.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.Model">
|
||
<summary>
|
||
Required. The model's resource name. This serves as an ID for the Model to use. Format: <c>models/{model}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.OutputAudioTranscription">
|
||
<summary>
|
||
Optional. If set, enables transcription of the model's audio output. The transcription aligns with the language code specified for the output audio, if configured.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.Proactivity">
|
||
<summary>
|
||
Optional. Configures the proactivity of the model. This allows the model to respond proactively to the input and to ignore irrelevant input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.RealtimeInputConfig">
|
||
<summary>
|
||
Optional. Configures the handling of realtime input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.SessionResumption">
|
||
<summary>
|
||
Optional. Configures session resumption mechanism. If included, the server will send <c>SessionResumptionUpdate</c> messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.SystemInstruction">
|
||
<summary>
|
||
Optional. The user provided system instructions for the model. Note: Only text should be used in parts and content in each part will be in a separate paragraph.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BidiGenerateContentSetup.Tools">
|
||
<summary>
|
||
Optional. A list of <c>Tools</c> the model may use to generate the next response. A <c>Tool</c> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BigQuerySource">
|
||
<summary>
|
||
The BigQuery location for the input content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BigQuerySource.InputUri">
|
||
<summary>
|
||
Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: <c>bq://projectId.bqDatasetId.bqTableId</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BleuMetricValue">
|
||
<summary>
|
||
Bleu metric value for an instance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BleuMetricValue.Score">
|
||
<summary>
|
||
Output only. Bleu score.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BleuSpec">
|
||
<summary>
|
||
Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BleuSpec.UseEffectiveOrder">
|
||
<summary>
|
||
Optional. Whether to use_effective_order to compute bleu score.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Blob">
|
||
<summary>
|
||
A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.
|
||
</summary>
|
||
<summary>
|
||
Raw media bytes. Text should not be sent as raw bytes, use the 'text' field.
|
||
</summary>
|
||
<summary>
|
||
Raw media bytes. Text should not be sent as raw bytes, use the 'text' field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blob.DisplayName">
|
||
<summary>
|
||
Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in <c>PromptMessage</c> for prompt management. It is used in the Gemini calls only when server-side tools (<c>code_execution</c>, <c>google_search</c>, and <c>url_context</c>) are enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blob.Data">
|
||
<summary>
|
||
Raw bytes for media formats.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blob.MimeType">
|
||
<summary>
|
||
The IANA standard MIME type of the source data. Examples: - image/png - image/jpeg If an unsupported MIME type is provided, an error will be returned. For a complete list of supported types, see [Supported file formats](https://ai.google.dev/gemini-api/docs/prompting_with_media#supported_file_formats).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Blobstore2Info">
|
||
<summary>
|
||
Information to read/write to blobstore2.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blobstore2Info.BlobId">
|
||
<summary>
|
||
The blob id, e.g., /blobstore/prod/playground/scotty
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blobstore2Info.ReadToken">
|
||
<summary>
|
||
The blob read token.
|
||
Needed to read blobs that have not been replicated. Might not be available until the final call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blobstore2Info.BlobGeneration">
|
||
<summary>
|
||
The blob generation id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blobstore2Info.UploadMetadataContainer">
|
||
<summary>
|
||
Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Blobstore2Info.DownloadReadHandle">
|
||
<summary>
|
||
Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockingConfidence.PhishBlockThresholdUnspecified">
|
||
<summary>
|
||
Defaults to unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockingConfidence.BlockLowAndAbove">
|
||
<summary>
|
||
Blocks Low and above confidence URL that is risky.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockingConfidence.BlockMediumAndAbove">
|
||
<summary>
|
||
Blocks Medium and above confidence URL that is risky.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockingConfidence.BlockHighAndAbove">
|
||
<summary>
|
||
Blocks High and above confidence URL that is risky.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockingConfidence.BlockHigherAndAbove">
|
||
<summary>
|
||
Blocks Higher and above confidence URL that is risky.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockingConfidence.BlockVeryHighAndAbove">
|
||
<summary>
|
||
Blocks Very high and above confidence URL that is risky.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockingConfidence.BlockOnlyExtremelyHigh">
|
||
<summary>
|
||
Blocks Extremely high confidence URL that is risky.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.BlockReasonUnspecified">
|
||
<summary>
|
||
Default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.BlockedReasonUnspecified">
|
||
<summary>
|
||
The blocked reason is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.Safety">
|
||
<summary>
|
||
Prompt was blocked due to safety reasons. Inspect `safety_ratings` to understand which safety category blocked it.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.Other">
|
||
<summary>
|
||
Prompt was blocked due to unknown reasons.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.Blocklist">
|
||
<summary>
|
||
Prompt was blocked due to the terms which are included from the terminology blocklist.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.ProhibitedContent">
|
||
<summary>
|
||
Prompt was blocked due to prohibited content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.ModelArmor">
|
||
<summary>
|
||
The prompt was blocked by Model Armor.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.ImageSafety">
|
||
<summary>
|
||
Candidates blocked due to unsafe image generation content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.BlockReason.Jailbreak">
|
||
<summary>
|
||
The prompt was blocked as a jailbreak attempt.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.BlurBaselineConfig">
|
||
<summary>
|
||
Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.BlurBaselineConfig.MaxBlurSigma">
|
||
<summary>
|
||
The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CachedContent">
|
||
<summary>
|
||
A resource used in LLM queries for users to explicitly specify what to cache and how to cache.
|
||
</summary>
|
||
<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="P:Mscc.GenerativeAI.Types.CachedContent.EncryptionSpec">
|
||
<summary>
|
||
Input only. Immutable. Customer-managed encryption key spec for a <c>CachedContent</c>. If set, this <c>CachedContent</c> and all its sub-resources will be secured by this key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.Model">
|
||
<summary>
|
||
Required. Immutable. The name of the `Model` to use for cached content Format: `models/{model}`
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.Name">
|
||
<summary>
|
||
Optional. Identifier. The resource name referring to the cached content. Format: `cachedContents/{id}`
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.Expiration">
|
||
<summary>
|
||
Specifies when this resource will expire.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.Ttl">
|
||
<summary>
|
||
Input only. New TTL for this resource, input only.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.Contents">
|
||
<summary>
|
||
Optional. Input only. Immutable. The content to cache.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.CreateTime">
|
||
<summary>
|
||
Output only. Creation time of the cache entry.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.DisplayName">
|
||
<summary>
|
||
Optional. Immutable. The user-generated meaningful display name of the cached content. Maximum 128 Unicode characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.ExpireTime">
|
||
<summary>
|
||
Timestamp in UTC of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.SystemInstruction">
|
||
<summary>
|
||
Optional. Input only. Immutable. Developer set system instruction. Currently text only.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.ToolConfig">
|
||
<summary>
|
||
Optional. Input only. Immutable. Tool config. This config is shared for all tools.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.Tools">
|
||
<summary>
|
||
Optional. Input only. Immutable. A list of <c>Tools</c> the model may use to generate the next response
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.UpdateTime">
|
||
<summary>
|
||
Output only. When the cache entry was last updated in UTC time.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContent.UsageMetadata">
|
||
<summary>
|
||
Output only. Metadata on the usage of the cached content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CachedContentUsageMetadata">
|
||
<summary>
|
||
Metadata on the usage of the cached content.
|
||
</summary>
|
||
<summary>
|
||
Metadata on the usage of the cached content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContentUsageMetadata.AudioDurationSeconds">
|
||
<summary>
|
||
Duration of audio in seconds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContentUsageMetadata.ImageCount">
|
||
<summary>
|
||
Number of images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContentUsageMetadata.TextCount">
|
||
<summary>
|
||
Number of text characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContentUsageMetadata.VideoDurationSeconds">
|
||
<summary>
|
||
Duration of video in seconds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CachedContentUsageMetadata.TotalTokenCount">
|
||
<summary>
|
||
Total number of tokens that the cached content consumes.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Candidate">
|
||
<summary>
|
||
A response candidate generated from the model.
|
||
</summary>
|
||
<summary>
|
||
A response candidate generated from the model.
|
||
</summary>
|
||
<summary>
|
||
A response candidate generated from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.Content">
|
||
<summary>
|
||
Output only. Generated content returned from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.UrlRetrievalMetadata">
|
||
<summary>
|
||
Output only. Metadata related to url context retrieval tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.AvgLogprobs">
|
||
<summary>
|
||
Output only. Average log probability score of the candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.CitationMetadata">
|
||
<summary>
|
||
Output only. Citation information for model-generated candidate. This field may be populated with recitation information for any text included in the <c>content</c>. These are passages that are "recited" from copyrighted material in the foundational LLM's training data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.FinishMessage">
|
||
<summary>
|
||
Optional. Output only. Details the reason why the model stopped generating tokens. This is populated only when <c>finish_reason</c> is set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.FinishReason">
|
||
<summary>
|
||
Optional. Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.GroundingAttributions">
|
||
<summary>
|
||
Output only. Attribution information for sources that contributed to a grounded answer. This field is populated for <c>GenerateAnswer</c> calls.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.GroundingMetadata">
|
||
<summary>
|
||
Output only. Grounding metadata for the candidate. This field is populated for <c>GenerateContent</c> calls.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.Index">
|
||
<summary>
|
||
Output only. Index of the candidate in the list of response candidates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.LogprobsResult">
|
||
<summary>
|
||
Output only. Log-likelihood scores for the response tokens and top tokens
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.SafetyRatings">
|
||
<summary>
|
||
List of ratings for the safety of a response candidate. There is at most one rating per category.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.TokenCount">
|
||
<summary>
|
||
Output only. Token count for this candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Candidate.UrlContextMetadata">
|
||
<summary>
|
||
Output only. Metadata related to url context retrieval tool.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ChatCompletionsRequest">
|
||
<summary>
|
||
Request for chat completions.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Model">
|
||
<summary>
|
||
Required. The name of the `Model` to use for generating the completion.
|
||
The model name will prefixed by \"models/\" if no slash appears in it.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Messages">
|
||
<summary>
|
||
Required. The chat history to use for generating the completion.
|
||
Supports single and multi-turn queries.
|
||
Note: This is a polymorphic field, it is deserialized to a InternalChatMessage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.MaxCompletionTokens">
|
||
<summary>
|
||
Optional. The maximum number of tokens to include in a response candidate.
|
||
Must be a positive integer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.MaxTokens">
|
||
<summary>
|
||
Optional. The maximum number of tokens to include in a response candidate.
|
||
Must be a positive integer. This field is deprecated by the SDK.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.N">
|
||
<summary>
|
||
Optional. Amount of candidate completions to generate.
|
||
Must be a positive integer. Defaults to 1 if not set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.ResponseFormat">
|
||
<summary>
|
||
Optional. Defines the format of the response. If not set, the response will be formatted as text.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Stop">
|
||
<summary>
|
||
Optional. The set of character sequences that will stop output generation.
|
||
Note: This is a polymorphic field. It is meant to contain a string or repeated strings.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Stream">
|
||
<summary>
|
||
Optional. Whether to stream the response or return a single response.
|
||
If true, the \"object\" field in the response will be \"chat.completion.chunk\".
|
||
Otherwise it will be \"chat.completion\".
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.StreamOptions">
|
||
<summary>
|
||
Optional. Options for streaming requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Temperature">
|
||
<summary>
|
||
Optional. Controls the randomness of the output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.TopP">
|
||
<summary>
|
||
Optional. The maximum cumulative probability of tokens to consider when sampling.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.ToolChoice">
|
||
<summary>
|
||
Optional. Controls whether the model should use a tool or not, and which tool to use.
|
||
Can be either:
|
||
- The string \"none\", to disable tools.
|
||
- The string \"auto\", to let the model decide.
|
||
- The string \"required\", to force the model to use a tool.
|
||
- A function name descriptor object, specifying the tool to use. The last option follows the following schema: { \"type\": \"function\", \"function\": {\"name\" : \"the_function_name\"} }
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Tools">
|
||
<summary>
|
||
Optional. The set of tools the model can generate calls for.
|
||
Each tool declares its signature.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Audio">
|
||
<summary>
|
||
Optional. Options for audio generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.Modalities">
|
||
<summary>
|
||
Optional. Modalities for the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.ParallelToolCalls">
|
||
<summary>
|
||
Optional. Whether to call tools in parallel.
|
||
</summary>
|
||
<remarks>
|
||
Included here for compatibility with the SDK, but only false is supported.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.PresencePenalty">
|
||
<summary>
|
||
Optional. Penalizes new tokens based on previous appearances. Valid ranges are [-2, 2]. Default is 0.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatCompletionsRequest.User">
|
||
<summary>
|
||
Optional. The user name used for tracking the request. Not used, only for compatibility with the SDK.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ChatFunction">
|
||
<summary>
|
||
A function that the model can generate calls for.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatFunction.Name">
|
||
<summary>
|
||
Required. The name of the function.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatFunction.Description">
|
||
<summary>
|
||
Optional. A description of the function.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatFunction.Strict">
|
||
<summary>
|
||
Optional. Whether the schema validation is strict.
|
||
If true, the model will fail if the schema is not valid.
|
||
NOTE: This parameter is currently ignored.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatFunction.Parameters">
|
||
<summary>
|
||
Optional. The parameters of the function.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ChatSession">
|
||
<summary>
|
||
Contains an ongoing conversation with the model.
|
||
</summary>
|
||
<remarks>
|
||
This ChatSession object collects the messages sent and received, in its ChatSession.History attribute.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatSession.History">
|
||
<summary>
|
||
The chat history.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatSession.Last">
|
||
<summary>
|
||
Returns the last received ContentResponse
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.#ctor(Mscc.GenerativeAI.GenerativeModel,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ContentResponse},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,System.Boolean)">
|
||
<summary>
|
||
Constructor to start a chat session with history.
|
||
</summary>
|
||
<param name="model">The model to use in the chat.</param>
|
||
<param name="history">A chat history to initialize the session with.</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">Optional. </param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.SendMessage(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the conversation history with the added message and returns the model's response.
|
||
Appends the request and response to the conversation history.
|
||
</summary>
|
||
<param name="request">The content request.</param>
|
||
<param name="generationConfig">Optional. Overrides for the model's generation config.</param>
|
||
<param name="safetySettings">Optional. Overrides for the model's safety settings.</param>
|
||
<param name="tools">Optional. Overrides for the list of tools the model may use to generate the next response.</param>
|
||
<param name="toolConfig">Optional. Overrides for the configuration of tools.</param>
|
||
<param name="requestOptions">Optional. Overrides for the request options.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>The model's response.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.BlockedPromptException">Thrown when the model's response is blocked by a reason.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.StopCandidateException">Thrown when the model's response is stopped by the model's safety settings.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.ValueErrorException">Thrown when the candidate count is larger than 1.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.SendMessage(System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the conversation history with the added message and returns the model's response.
|
||
Appends the request and response to the conversation history.
|
||
</summary>
|
||
<param name="prompt">The message or content sent.</param>
|
||
<param name="generationConfig">Optional. Overrides for the model's generation config.</param>
|
||
<param name="safetySettings">Optional. Overrides for the model's safety settings.</param>
|
||
<param name="tools">Optional. Overrides for the list of tools the model may use to generate the next response.</param>
|
||
<param name="toolConfig">Optional. Overrides for the configuration of tools.</param>
|
||
<param name="requestOptions">Optional. Overrides for the request options.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>The model's response.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.SendMessage(System.Collections.Generic.List{Mscc.GenerativeAI.Types.Part},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the conversation history with the added message and returns the model's response.
|
||
Appends the request and response to the conversation history.
|
||
</summary>
|
||
<param name="parts">The list of content parts sent.</param>
|
||
<param name="generationConfig">Optional. Overrides for the model's generation config.</param>
|
||
<param name="safetySettings">Optional. Overrides for the model's safety settings.</param>
|
||
<param name="tools">Optional. Overrides for the list of tools the model may use to generate the next response.</param>
|
||
<param name="toolConfig">Optional. Overrides for the configuration of tools.</param>
|
||
<param name="requestOptions">Optional. Overrides for the request options.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>The model's response.</returns>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.ValueErrorException">Thrown when the candidate count is larger than 1.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.SendMessageStream(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the conversation history with the added message and returns the model's response.
|
||
</summary>
|
||
<remarks>Appends the request and response to the conversation history.</remarks>
|
||
<param name="request">The content request.</param>
|
||
<param name="generationConfig">Optional. Overrides for the model's generation config.</param>
|
||
<param name="safetySettings">Optional. Overrides for the model's safety settings.</param>
|
||
<param name="tools">Optional. Overrides for the list of tools the model may use to generate the next response.</param>
|
||
<param name="toolConfig">Optional. Overrides for the configuration of tools.</param>
|
||
<param name="requestOptions">Optional. Overrides for the request options.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>The model's response.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="request"/> is <see langword="null"/></exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.BlockedPromptException">Thrown when the <paramref name="request"/> is blocked by a reason.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.ValueErrorException">Thrown when the candidate count is larger than 1.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.SendMessageStream(System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the conversation history with the added message and returns the model's response.
|
||
Appends the request and response to the conversation history.
|
||
</summary>
|
||
<param name="prompt">The message sent.</param>
|
||
<param name="generationConfig">Optional. Overrides for the model's generation config.</param>
|
||
<param name="safetySettings">Optional. Overrides for the model's safety settings.</param>
|
||
<param name="tools">Optional. Overrides for the list of tools the model may use to generate the next response.</param>
|
||
<param name="toolConfig">Optional. Overrides for the configuration of tools.</param>
|
||
<param name="requestOptions">Optional. Overrides for the request options.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>The model's response.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.SendMessageStream(System.Collections.Generic.List{Mscc.GenerativeAI.Types.Part},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Sends the conversation history with the added message and returns the model's response.
|
||
Appends the request and response to the conversation history.
|
||
</summary>
|
||
<param name="parts">The list of content parts sent.</param>
|
||
<param name="generationConfig">Optional. Overrides for the model's generation config.</param>
|
||
<param name="safetySettings">Optional. Overrides for the model's safety settings.</param>
|
||
<param name="tools">Optional. Overrides for the list of tools the model may use to generate the next response.</param>
|
||
<param name="toolConfig">Optional. Overrides for the configuration of tools.</param>
|
||
<param name="requestOptions">Optional. Overrides for the request options.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>The model's response.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="parts"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ChatSession.Rewind">
|
||
<summary>
|
||
Removes the last request/response pair from the chat history.
|
||
</summary>
|
||
<returns>Tuple with the last request/response pair.</returns>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ChatTool">
|
||
<summary>
|
||
A tool that the model can generate calls for.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatTool.Function">
|
||
<summary>
|
||
Required. The name of the tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChatTool.Type">
|
||
<summary>
|
||
Required. Required, must be \"function\".
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Checkpoint">
|
||
<summary>
|
||
Describes the machine learning model version checkpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Checkpoint.CheckpointId">
|
||
<summary>
|
||
The ID of the checkpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Checkpoint.Epoch">
|
||
<summary>
|
||
The epoch of the checkpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Checkpoint.Step">
|
||
<summary>
|
||
The step of the checkpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Chunk">
|
||
<summary>
|
||
Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
|
||
</summary>
|
||
<summary>
|
||
A <see cref="T:Mscc.GenerativeAI.Types.Chunk"/> is a subpart of a <see cref="T:Mscc.GenerativeAI.Types.Document"/> that is treated as an independent unit for the purposes of vector representation and storage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.Metadata">
|
||
<summary>
|
||
Optional. Metadata that is associated with the data in the payload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.MimeType">
|
||
<summary>
|
||
Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.CreateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/> was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.CustomMetadata">
|
||
<summary>
|
||
Optional. User provided custom metadata stored as key-value pairs. The maximum number of <see cref="P:Mscc.GenerativeAI.Types.Chunk.CustomMetadata"/> per chunk is 20.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.Data">
|
||
<summary>
|
||
Required. The content for the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>, such as the text string. The maximum number of tokens per chunk is 2043.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.Name">
|
||
<summary>
|
||
Immutable. Identifier. The <see cref="T:Mscc.GenerativeAI.Types.Chunk"/> resource name. The ID (name excluding the "corpora/*/documents/*/chunks/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a random 12-character unique ID will be generated. Example: <see cref="!:corpora/<corpus_id>/documents/<document_id>/chunks/123a456b789c"/>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.State">
|
||
<summary>
|
||
Output only. Current state of the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Chunk.UpdateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/> was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ChunkData">
|
||
<summary>
|
||
Extracted data that represents the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/> content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChunkData.StringValue">
|
||
<summary>
|
||
The <see cref="T:Mscc.GenerativeAI.Types.Chunk"/> content as a string. The maximum number of tokens per chunk is 2043.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ChunkingConfig">
|
||
<summary>
|
||
Parameters for telling the service how to chunk the file.
|
||
inspired by google3/cloud/ai/platform/extension/lib/retrieval/config/chunker_config.proto
|
||
</summary>
|
||
<summary>
|
||
Parameters for telling the service how to chunk the file. inspired by google3/cloud/ai/platform/extension/lib/retrieval/config/chunker_config.proto
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChunkingConfig.ChunkSize">
|
||
<summary>
|
||
Number of tokens each chunk should have.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChunkingConfig.ChunkOverlap">
|
||
<summary>
|
||
Number of tokens overlap between chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ChunkingConfig.WhiteSpaceConfig">
|
||
<summary>
|
||
White space chunking configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Citation">
|
||
<summary>
|
||
A citation for a piece of generatedcontent.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Citation.EndIndex">
|
||
<summary>
|
||
Output only. The end index of the citation in the content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Citation.License">
|
||
<summary>
|
||
Output only. The license of the source of the citation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Citation.PublicationDate">
|
||
<summary>
|
||
Output only. The publication date of the source of the citation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Citation.StartIndex">
|
||
<summary>
|
||
Output only. The start index of the citation in the content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Citation.Title">
|
||
<summary>
|
||
Output only. The title of the source of the citation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Citation.Uri">
|
||
<summary>
|
||
Output only. The URI of the source of the citation.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CitationMetadata">
|
||
<summary>
|
||
A collection of citations that apply to a piece of generated content.
|
||
</summary>
|
||
<summary>
|
||
A collection of source attributions for a piece of content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationMetadata.Citations">
|
||
<summary>
|
||
Output only. A list of citations for the content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationMetadata.CitationSources">
|
||
<summary>
|
||
Citations to sources for a specific response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CitationSource">
|
||
<summary>
|
||
A citation to a source for a portion of a specific response.
|
||
</summary>
|
||
<summary>
|
||
A citation to a source for a portion of a specific response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationSource.Title">
|
||
<summary>
|
||
Output only. The title of the source of the citation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationSource.PublicationDate">
|
||
<summary>
|
||
Output only. The publication date of the source of the citation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationSource.EndIndex">
|
||
<summary>
|
||
Optional. End of the attributed segment, exclusive.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationSource.License">
|
||
<summary>
|
||
Optional. License for the GitHub project that is attributed as a source for segment. License info is required for code citations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationSource.StartIndex">
|
||
<summary>
|
||
Optional. Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CitationSource.Uri">
|
||
<summary>
|
||
Optional. URI that is attributed as a source for a portion of the text.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CodeExecution">
|
||
<summary>
|
||
Tool that executes code generated by the model, and automatically returns the result to the model. See also <see cref="T:Mscc.GenerativeAI.Types.ExecutableCode"/> and <see cref="T:Mscc.GenerativeAI.Types.CodeExecutionResult"/> which are only generated when using this tool.
|
||
</summary>
|
||
<summary>
|
||
Tool that executes code generated by the model, and automatically returns the result to the model. See also <c>ExecutableCode</c> and <c>CodeExecutionResult</c> which are only generated when using this tool.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CodeExecutionResult">
|
||
<summary>
|
||
Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a <c>part</c> containing the [ExecutableCode].
|
||
</summary>
|
||
<summary>
|
||
Result of executing the <see cref="T:Mscc.GenerativeAI.Types.ExecutableCode"/>. Only generated when using the <see cref="T:Mscc.GenerativeAI.Types.CodeExecution"/>, and always follows a <see cref="!:part"/> containing the <see cref="T:Mscc.GenerativeAI.Types.ExecutableCode"/>.
|
||
</summary>
|
||
<summary>
|
||
Result of executing the <c>ExecutableCode</c>. Generated only when the <c>CodeExecution</c> tool is used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CodeExecutionResult.Outcome">
|
||
<summary>
|
||
Required. Outcome of the code execution.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CodeExecutionResult.Output">
|
||
<summary>
|
||
Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CompositeMedia">
|
||
<summary>
|
||
A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Inline">
|
||
<summary>
|
||
Media data, set if reference_type is INLINE
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Path">
|
||
<summary>
|
||
Path to the data, set if reference_type is PATH
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.ReferenceType">
|
||
<summary>
|
||
Describes what the field reference contains.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Md5Hash">
|
||
<summary>
|
||
Scotty-provided MD5 hash for an upload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Sha1Hash">
|
||
<summary>
|
||
Scotty-provided SHA1 hash for an upload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Sha256Hash">
|
||
<summary>
|
||
Scotty-provided SHA256 hash for an upload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Crc32cHash">
|
||
<summary>
|
||
For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.BlobRef">
|
||
<summary>
|
||
Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Length">
|
||
<summary>
|
||
Size of the data, in bytes
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.ObjectId">
|
||
<summary>
|
||
Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.CosmoBinaryReference">
|
||
<summary>
|
||
A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CompositeMedia.Blobstore2Info">
|
||
<summary>
|
||
Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ComputationBasedMetricSpec">
|
||
<summary>
|
||
Specification for a computation based metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputationBasedMetricSpec.Parameters">
|
||
<summary>
|
||
Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputationBasedMetricSpec.Type">
|
||
<summary>
|
||
Required. The type of the computation based metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ComputationBasedMetricSpec.ComputationBasedMetricSpecType.ComputationBasedMetricTypeUnspecified">
|
||
<summary>
|
||
Unspecified computation based metric type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ComputationBasedMetricSpec.ComputationBasedMetricSpecType.ExactMatch">
|
||
<summary>
|
||
Exact match metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ComputationBasedMetricSpec.ComputationBasedMetricSpecType.Bleu">
|
||
<summary>
|
||
BLEU metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ComputationBasedMetricSpec.ComputationBasedMetricSpecType.Rouge">
|
||
<summary>
|
||
ROUGE metric.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ComputerUse">
|
||
<summary>
|
||
Computer Use tool type.
|
||
</summary>
|
||
<summary>
|
||
Computer Use tool type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputerUse.Environment">
|
||
<summary>
|
||
Required. The environment being operated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputerUse.ExcludedPredefinedFunctions">
|
||
<summary>
|
||
Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ComputerUseEnvironment.EnvironmentUnspecified">
|
||
<summary>
|
||
Defaults to browser.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ComputerUseEnvironment.EnvironmentBrowser">
|
||
<summary>
|
||
Operates in a web browser.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ComputerUseEnvironment.Browser">
|
||
<summary>
|
||
Operates in a web browser.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ComputeTokensConfig">
|
||
<summary>
|
||
Optional parameters for computing tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ComputeTokensRequest">
|
||
<summary>
|
||
Request message for ComputeTokens RPC call.
|
||
</summary>
|
||
<summary>
|
||
Request message for ComputeTokens RPC call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputeTokensRequest.Contents">
|
||
<summary>
|
||
Optional. Input content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputeTokensRequest.Instances">
|
||
<summary>
|
||
Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputeTokensRequest.Model">
|
||
<summary>
|
||
Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputeTokensRequest.Config">
|
||
<summary>
|
||
Optional parameters for the request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ComputeTokensResponse">
|
||
<summary>
|
||
Response message for ComputeTokens RPC call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ComputeTokensResponse.TokensInfo">
|
||
<summary>
|
||
Lists of tokens info from the input. A ComputeTokensRequest could have multiple instances with a prompt in each instance. We also need to return lists of tokens info for the request with multiple instances.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Condition">
|
||
<summary>
|
||
Filter condition applicable to a single key.
|
||
</summary>
|
||
<summary>
|
||
Filter condition applicable to a single key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Condition.Operation">
|
||
<summary>
|
||
Required. Operator applied to the given key-value pair to trigger the condition.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Condition.NumericValue">
|
||
<summary>
|
||
The numeric value to filter the metadata on.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Condition.StringValue">
|
||
<summary>
|
||
The string value to filter the metadata on.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Content">
|
||
<summary>
|
||
The base structured datatype containing multipart content of a message.
|
||
Ref: https://ai.google.dev/api/rest/v1beta/Content
|
||
</summary>
|
||
<summary>
|
||
The base structured datatype containing multi-part content of a message. A <c>Content</c> includes a <c>role</c> field designating the producer of the <c>Content</c> and a <c>parts</c> field containing multi-part data that contains the content of the message turn.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Content.Parts">
|
||
<summary>
|
||
Ordered Parts that constitute a single message. Parts may have different MIME types.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Content.Role">
|
||
<summary>
|
||
Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the
|
||
service will default to 'user'.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Content.PartTypes">
|
||
<summary>
|
||
Ordered Parts that constitute a single message. Parts may have different MIME types.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Content.ETag">
|
||
<summary>
|
||
The ETag of the item.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Content.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Content"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Content.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Content"/> class.
|
||
</summary>
|
||
<param name="text">String to process.</param>
|
||
<param name="role">Provide the <see cref="T:Mscc.GenerativeAI.Types.Role"/> of the text.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Content.#ctor(Mscc.GenerativeAI.Types.IPart,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Content"/> class.
|
||
</summary>
|
||
<param name="part">The part to add.</param>
|
||
<param name="role">Provide the <see cref="T:Mscc.GenerativeAI.Types.Role"/> of the text.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="part"/> is null.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Content.#ctor(System.Collections.Generic.IEnumerable{Mscc.GenerativeAI.Types.IPart},System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Content"/> class.
|
||
</summary>
|
||
<param name="parts">The parts to add.</param>
|
||
<param name="role">Provide the <see cref="T:Mscc.GenerativeAI.Types.Role"/> of the text.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="parts"/> is null.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ContentResponse">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ContentResponse.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.ContentResponse"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ContentResponse.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.ContentResponse"/> class.
|
||
</summary>
|
||
<param name="text">String to process.</param>
|
||
<param name="role">Role of the content. Must be either 'user' or 'model'.</param>
|
||
<exception cref="T:System.ArgumentException">Thrown when <paramref name="text"/> or <paramref name="role"/> is empty or null.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ContentEmbedding">
|
||
<summary>
|
||
A list of floats representing an embedding.
|
||
</summary>
|
||
<summary>
|
||
A list of floats representing an embedding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentEmbedding.Values">
|
||
<summary>
|
||
The embedding values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentEmbedding.Shape">
|
||
<summary>
|
||
This field stores the soft tokens tensor frame shape (e.g. [1, 1, 256, 2048]).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ContentFilter">
|
||
<summary>
|
||
Content filtering metadata associated with processing a single request. ContentFilter contains a reason and an optional supporting string. The reason may be unspecified.
|
||
</summary>
|
||
<summary>
|
||
Content filtering metadata associated with processing a single request. ContentFilter contains a reason and an optional supporting string. The reason may be unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentFilter.Reason">
|
||
<summary>
|
||
The reason content was blocked during request processing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentFilter.Message">
|
||
<summary>
|
||
A string that describes the filtering behavior in more detail.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ContentsExample">
|
||
<summary>
|
||
A single example of a conversation with the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentsExample.Contents">
|
||
<summary>
|
||
Required. The content of the conversation with the model that resulted in the expected output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentsExample.ExpectedContents">
|
||
<summary>
|
||
Required. The expected output for the given <c>contents</c>. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ContentsExampleExpectedContent">
|
||
<summary>
|
||
A single step of the expected output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentsExampleExpectedContent.Content">
|
||
<summary>
|
||
Required. A single step's content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ContentTypeInfo">
|
||
<summary>
|
||
Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentTypeInfo.FromBytes">
|
||
<summary>
|
||
The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentTypeInfo.FromUrlPath">
|
||
<summary>
|
||
The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentTypeInfo.FromHeader">
|
||
<summary>
|
||
The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentTypeInfo.FromFileName">
|
||
<summary>
|
||
The content type of the file derived from the file extension of the original file name used by the client.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContentTypeInfo.BestGuess">
|
||
<summary>
|
||
Scotty's best guess of what the content type of the file is.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ContextWindowCompressionConfig">
|
||
<summary>
|
||
Enables context window compression — a mechanism for managing the model's context window so that it does not exceed a given length.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContextWindowCompressionConfig.SlidingWindow">
|
||
<summary>
|
||
A sliding-window mechanism.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ContextWindowCompressionConfig.TriggerTokens">
|
||
<summary>
|
||
The number of tokens (before running a turn) required to trigger a context window compression. This can be used to balance quality against latency as shorter context windows may result in faster model responses. However, any compression operation will cause a temporary latency increase, so they should not be triggered frequently. If not set, the default is 80% of the model's context window limit. This leaves 20% for the next user request/model response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ControlImageConfig">
|
||
<summary>
|
||
Configuration for a Control reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ControlImageConfig.ControlType">
|
||
<summary>
|
||
The type of control reference image to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ControlImageConfig.EnableControlImageComputation">
|
||
<summary>
|
||
When set to True, the control image will be computed by the model based on the control type.
|
||
When set to False, the control image must be provided by the user.
|
||
</summary>
|
||
<remarks>
|
||
Defaults to False.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ControlReferenceType">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ControlReferenceType.ControlTypeDefault">
|
||
<summary>
|
||
Default control type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ControlReferenceType.ControlTypeCanny">
|
||
<summary>
|
||
for canny edge
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ControlReferenceType.ControlTypeFaceMesh">
|
||
<summary>
|
||
for face mesh (person customization)
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ControlReferenceType.ControlTypeScribble">
|
||
<summary>
|
||
for scribble
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CopyModelOperationMetadata">
|
||
<summary>
|
||
Details of ModelService.CopyModel operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CopyModelOperationMetadata.GenericMetadata">
|
||
<summary>
|
||
The common part of the operation metadata.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CopyModelRequest">
|
||
<summary>
|
||
Request message for ModelService.CopyModel.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CopyModelRequest.EncryptionSpec">
|
||
<summary>
|
||
Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CopyModelRequest.ModelId">
|
||
<summary>
|
||
Optional. Copy source_model into a new Model with this ID. The ID will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are <c>[a-z0-9_-]</c>. The first character cannot be a number or hyphen.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CopyModelRequest.ParentModel">
|
||
<summary>
|
||
Optional. Specify this field to copy source_model into this existing Model as a new version. Format: <c>projects/{project}/locations/{location}/models/{model}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CopyModelRequest.SourceModel">
|
||
<summary>
|
||
Required. The resource name of the Model to copy. That Model must be in the same Project. Format: <c>projects/{project}/locations/{location}/models/{model}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CopyModelResponse">
|
||
<summary>
|
||
The copied model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CopyModelResponse.Name">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CopyModelResponse.Metadata">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Corpus">
|
||
<summary>
|
||
A <see cref="T:Mscc.GenerativeAI.Types.Corpus"/> is a collection of <see cref="T:Mscc.GenerativeAI.Types.Document"/>s. A project can create up to 10 corpora.
|
||
</summary>
|
||
<summary>
|
||
A <c>Corpus</c> is a collection of <c>Document</c>s. A project can create up to 10 corpora.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Corpus.CreateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <c>Corpus</c> was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Corpus.DisplayName">
|
||
<summary>
|
||
Optional. The human-readable display name for the <c>Corpus</c>. The display name must be no more than 512 characters in length, including spaces. Example: "Docs on Semantic Retriever"
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Corpus.Name">
|
||
<summary>
|
||
Output only. Immutable. Identifier. The <c>Corpus</c> resource name. The ID (name excluding the "corpora/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be derived from <c>display_name</c> along with a 12 character random suffix. Example: <c>corpora/my-awesome-corpora-123a456b789c</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Corpus.UpdateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <c>Corpus</c> was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CorpusQueryRequest">
|
||
<summary>
|
||
Request for querying a `Corpus`.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CorpusQueryRequest.Query">
|
||
<summary>
|
||
Required. Query string to perform semantic search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CorpusQueryRequest.MetadataFilters">
|
||
<summary>
|
||
Optional. Filter for `Chunk` and `Document` metadata.
|
||
Each `MetadataFilter` object should correspond to a unique key. Multiple `MetadataFilter` objects are joined by logical \"AND\"s. Example query at document level: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action) `MetadataFilter` object list: metadata_filters = [ {key = \"document.custom_metadata.year\" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = \"document.custom_metadata.year\" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = \"document.custom_metadata.genre\" conditions = [{string_value = \"drama\", operation = EQUAL}, {string_value = \"action\", operation = EQUAL}]}] Example query at chunk level for a numeric range of values: (year > 2015 AND year <= 2020) `MetadataFilter` object list: metadata_filters = [ {key = \"chunk.custom_metadata.year\" conditions = [{int_value = 2015, operation = GREATER}]}, {key = \"chunk.custom_metadata.year\" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}] Note: \"AND\"s for the same key are only supported for numeric values. String values only support \"OR\"s for the same key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CorpusQueryRequest.ResultsCount">
|
||
<summary>
|
||
Optional. The maximum number of `Chunk`s to return.
|
||
The service may return fewer `Chunk`s. If unspecified, at most 10 `Chunk`s will be returned. The maximum specified result count is 100.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CorpusQueryResponse">
|
||
<summary>
|
||
Response from `QueryCorpus` containing a list of relevant chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CorpusQueryResponse.RelevantChunks">
|
||
<summary>
|
||
The relevant chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CorpusStatus">
|
||
<summary>
|
||
RagCorpus status.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CorpusStatus.ErrorStatus">
|
||
<summary>
|
||
Output only. Only when the <c>state</c> field is ERROR.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CorpusStatus.State">
|
||
<summary>
|
||
Output only. RagCorpus life state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.CorpusStatus.StateType.Unknown">
|
||
<summary>
|
||
This state is not supposed to happen.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.CorpusStatus.StateType.Initialized">
|
||
<summary>
|
||
RagCorpus resource entry is initialized, but hasn't done validation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.CorpusStatus.StateType.Active">
|
||
<summary>
|
||
RagCorpus is provisioned successfully and is ready to serve.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.CorpusStatus.StateType.Error">
|
||
<summary>
|
||
RagCorpus is in a problematic situation. See `error_message` field for details.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CountMessageTokensRequest">
|
||
<summary>
|
||
Counts the number of tokens in the <c>prompt</c> sent to a model. Models may tokenize text differently, so each model may return a different <c>token_count</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountMessageTokensRequest.Prompt">
|
||
<summary>
|
||
Required. The prompt, whose token count is to be returned.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CountMessageTokensResponse">
|
||
<summary>
|
||
A response from <c>CountMessageTokens</c>. It returns the model's <c>token_count</c> for the <c>prompt</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountMessageTokensResponse.TokenCount">
|
||
<summary>
|
||
The number of tokens that the <c>model</c> tokenizes the <c>prompt</c> into. Always non-negative.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CountTextTokensRequest">
|
||
<summary>
|
||
Counts the number of tokens in the <c>prompt</c> sent to a model. Models may tokenize text differently, so each model may return a different <c>token_count</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTextTokensRequest.Prompt">
|
||
<summary>
|
||
Required. The free-form input text given to the model as a prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CountTextTokensResponse">
|
||
<summary>
|
||
A response from <c>CountTextTokens</c>. It returns the model's <c>token_count</c> for the <c>prompt</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTextTokensResponse.TokenCount">
|
||
<summary>
|
||
The number of tokens that the <c>model</c> tokenizes the <c>prompt</c> into. Always non-negative.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CountTokensConfig">
|
||
<summary>
|
||
Config for the count_tokens method.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensConfig.GenerationConfig">
|
||
<summary>
|
||
Configuration that the model uses to generate the response. Not supported by the Gemini Developer API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensConfig.SystemInstruction">
|
||
<summary>
|
||
Instructions for the model to steer it toward better performance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensConfig.Tools">
|
||
<summary>
|
||
Code that enables the system to interact with external systems to perform an action outside of the knowledge and scope of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CountTokensRequest">
|
||
<summary>
|
||
Request message for PredictionService.CountTokens.
|
||
</summary>
|
||
<summary>
|
||
Request for counting tokens.
|
||
</summary>
|
||
<summary>
|
||
Counts the number of tokens in the <c>prompt</c> sent to a model. Models may tokenize text differently, so each model may return a different <c>token_count</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.GenerationConfig">
|
||
<summary>
|
||
Optional. Generation config that the model will use to generate the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.Instances">
|
||
<summary>
|
||
Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.Model">
|
||
<summary>
|
||
Optional. The name of the publisher model requested to serve the prediction. Format: <c>projects/{project}/locations/{location}/publishers/*/models/*</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.SystemInstruction">
|
||
<summary>
|
||
Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.Tools">
|
||
<summary>
|
||
Optional. A list of <c>Tools</c> the model may use to generate the next response. A <c>Tool</c> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.Config">
|
||
<summary>
|
||
Configuration for counting tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.Contents">
|
||
<summary>
|
||
Optional. The input given to the model as a prompt. This field is ignored when <c>generate_content_request</c> is set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensRequest.GenerateContentRequest">
|
||
<summary>
|
||
Optional. The overall input given to the <c>Model</c>. This includes the prompt as well as other model steering information like [system instructions](https://ai.google.dev/gemini-api/docs/system-instructions), and/or function declarations for [function calling](https://ai.google.dev/gemini-api/docs/function-calling). <c>Model</c>s/<c>Content</c>s and <c>generate_content_request</c>s are mutually exclusive. You can either send <c>Model</c> + <c>Content</c>s or a <c>generate_content_request</c>, but never both.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CountTokensResponse">
|
||
<summary>
|
||
Response message for PredictionService.CountTokens.
|
||
</summary>
|
||
<summary>
|
||
A response from `CountTokens`. It returns the model's `token_count` for the `prompt`.
|
||
</summary>
|
||
<summary>
|
||
A response from <c>CountTokens</c>. It returns the model's <c>token_count</c> for the <c>prompt</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensResponse.TotalBillableCharacters">
|
||
<summary>
|
||
The total number of billable characters counted across all instances from the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensResponse.TotalTokens">
|
||
<summary>
|
||
The number of tokens that the <see cref="T:Mscc.GenerativeAI.Types.Model"/> tokenizes the <see cref="!:prompt"/> into. Always non-negative.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensResponse.TokenCount">
|
||
<summary>
|
||
The total number of tokens counted across all instances from the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensResponse.CachedContentTokenCount">
|
||
<summary>
|
||
Number of tokens in the cached part of the prompt (the cached content).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensResponse.CacheTokensDetails">
|
||
<summary>
|
||
Output only. List of modalities that were processed in the cached content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CountTokensResponse.PromptTokensDetails">
|
||
<summary>
|
||
Output only. List of modalities that were processed in the request input.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CreateBatchJobConfig">
|
||
<summary>
|
||
Config for optional parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateBatchJobConfig.Dest">
|
||
<summary>
|
||
GCS or BigQuery URI prefix for the output predictions. Example: “gs://path/to/output/data” or “bq://projectId.bqDatasetId.bqTableId”.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateBatchJobConfig.DisplayName">
|
||
<summary>
|
||
The user-defined name of this BatchJob.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CreateChunkRequest">
|
||
<summary>
|
||
Request to create a <see cref="P:Mscc.GenerativeAI.Types.CreateChunkRequest.Chunk"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateChunkRequest.Chunk">
|
||
<summary>
|
||
Required. The <see cref="P:Mscc.GenerativeAI.Types.CreateChunkRequest.Chunk"/> to create.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateChunkRequest.Parent">
|
||
<summary>
|
||
Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.Document"/> where this <see cref="P:Mscc.GenerativeAI.Types.CreateChunkRequest.Chunk"/> will be created. Example: <see cref="!:corpora/my-corpus-123/documents/the-doc-abc"/>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CreateFileRequest">
|
||
<summary>
|
||
Request for <c>CreateFile</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateFileRequest.File">
|
||
<summary>
|
||
Optional. Metadata for the file to create.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CreateFileResponse">
|
||
<summary>
|
||
Response for <c>CreateFile</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateFileResponse.File">
|
||
<summary>
|
||
Metadata for the created file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CreateTunedModelRequest">
|
||
<summary>
|
||
Request to create a tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateTunedModelRequest.DisplayName">
|
||
<summary>
|
||
The name to display for this model in user interfaces. The display name must be up to 40 characters including spaces.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateTunedModelRequest.BaseModel">
|
||
<summary>
|
||
The name of the Model to tune. Example: models/text-bison-001
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateTunedModelRequest.TuningTask">
|
||
<summary>
|
||
Tuning tasks that create tuned models.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.CreateTunedModelRequest.#ctor">
|
||
<summary>
|
||
Constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.CreateTunedModelRequest.#ctor(System.String,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.TuningExample},Mscc.GenerativeAI.Types.Hyperparameters)">
|
||
<summary>
|
||
Creates a request for a tuned model.
|
||
</summary>
|
||
<param name="model">Model to use.</param>
|
||
<param name="name">Name of the tuned model.</param>
|
||
<param name="dataset">Dataset for training or validation.</param>
|
||
<param name="parameters">Immutable. Hyperparameters controlling the tuning process. If not provided, default values will be used.</param>
|
||
<exception cref="T:System.ArgumentNullException"></exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CreateTunedModelResponse">
|
||
<summary>
|
||
Response of a newly created tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateTunedModelMetadata.TunedModel">
|
||
<summary>
|
||
A fine-tuned model created using ModelService.CreateTunedModel.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CreateTuningJobRequest">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateTuningJobRequest.BaseModel">
|
||
<summary>
|
||
Optional. Name of the foundation model to tune.
|
||
</summary>
|
||
<remarks>
|
||
Supported values: gemini-1.5-pro-002, gemini-1.5-flash-002, and gemini-1.0-pro-002.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateTuningJobRequest.SupervisedTuningSpec">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CreateTuningJobRequest.TunedModelDisplayName">
|
||
<summary>
|
||
Optional. A display name for the tuned model. If not set, a random name is generated.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.CreateTuningJobRequest.#ctor">
|
||
<summary>
|
||
Creates an instance of <see cref="P:Mscc.GenerativeAI.Types.CreateTuningJobRequest.SupervisedTuningSpec"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.CreateTuningJobRequest.#ctor(System.String,System.String,System.String,System.String,Mscc.GenerativeAI.Types.SupervisedHyperParameters)">
|
||
<summary>
|
||
Creates a request for tuning a model.
|
||
</summary>
|
||
<param name="model">Model to use.</param>
|
||
<param name="datasetUri">URI of dataset for training.</param>
|
||
<param name="validationUri">URI of dataset for validation.</param>
|
||
<param name="displayName"></param>
|
||
<param name="parameters">Immutable. Hyperparameters controlling the tuning process. If not provided, default values will be used.</param>
|
||
<exception cref="T:System.ArgumentException">Thrown when <paramref name="model"/> is empty or null.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when <paramref name="datasetUri"/> is empty or null.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Credentials">
|
||
<summary>
|
||
Represents the credentials used to authenticate with the API.
|
||
It de/serializes the content of the client_secret.json file for OAuth 2.0
|
||
using either Desktop or Web approach, and supports Service Accounts on Google Cloud Platform.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.Web">
|
||
<summary>
|
||
Client secrets for web applications.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.Installed">
|
||
<summary>
|
||
Client secrets for desktop applications.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.Account">
|
||
<summary>
|
||
Account used in Google CLoud Platform.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.RefreshToken">
|
||
<summary>
|
||
Refresh token for the API to retrieve a new access token.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.Type">
|
||
<summary>
|
||
Type of account in Google Cloud Platform.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.UniverseDomain">
|
||
<summary>
|
||
Uri of domain
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.ProjectId">
|
||
<summary>
|
||
Project ID in Google Cloud Platform.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Credentials.QuotaProjectId">
|
||
<summary>
|
||
Project ID (quota) in Google Cloud Platform.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ClientSecrets">
|
||
<summary>
|
||
Represents the content of a client_secret.json file used in Google Cloud Platform
|
||
to authenticate a user or service account.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ClientSecrets.ClientId">
|
||
<summary>
|
||
Client ID
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ClientSecrets.ClientSecret">
|
||
<summary>
|
||
Client secret
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ClientSecrets.RedirectUris">
|
||
<summary>
|
||
List of Callback URLs in case of a web application.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ClientSecrets.AuthUri">
|
||
<summary>
|
||
Authentication endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ClientSecrets.AuthProviderX509CertUrl">
|
||
<summary>
|
||
URL to an X509 certificate provider.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ClientSecrets.TokenUri">
|
||
<summary>
|
||
Uri of token.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CustomCodeExecutionResult">
|
||
<summary>
|
||
Result for custom code execution metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomCodeExecutionResult.Score">
|
||
<summary>
|
||
Output only. Custom code execution score.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CustomCodeExecutionSpec">
|
||
<summary>
|
||
Specificies a metric that is populated by evaluating user-defined Python code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomCodeExecutionSpec.EvaluationFunction">
|
||
<summary>
|
||
Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``<c> instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) </c>`<c> Example converted input: </c>`<c> { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } </c>`<c> Example python function: </c>`<c> def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 </c>`` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomLongRunningOperation.Done">
|
||
<summary>
|
||
If the value is <c>false</c>, it means the operation is still in progress. If <c>true</c>, the operation is completed, and either <c>error</c> or <c>response</c> is available.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomLongRunningOperation.Error">
|
||
<summary>
|
||
The error result of the operation in case of failure or cancellation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomLongRunningOperation.Metadata">
|
||
<summary>
|
||
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomLongRunningOperation.Name">
|
||
<summary>
|
||
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the <c>name</c> should be a resource name ending with <c>operations/{unique_id}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomLongRunningOperation.Response">
|
||
<summary>
|
||
The normal, successful response of the operation. If the original method returns no data on success, such as <c>Delete</c>, the response is <c>google.protobuf.Empty</c>. If the original method is standard <c>Get</c>/<c>Create</c>/<c>Update</c>, the response should be the resource. For other methods, the response should have the type <c>XxxResponse</c>, where <c>Xxx</c> is the original method name. For example, if the original method name is <c>TakeSnapshot()</c>, the inferred response type is <c>TakeSnapshotResponse</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CustomMetadata">
|
||
<summary>
|
||
User provided metadata stored as key-value pairs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomMetadata.Key">
|
||
<summary>
|
||
Required. The key of the metadata to store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomMetadata.NumericValue">
|
||
<summary>
|
||
The numeric value of the metadata to store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomMetadata.StringListValue">
|
||
<summary>
|
||
The StringList value of the metadata to store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomMetadata.StringValue">
|
||
<summary>
|
||
The string value of the metadata to store.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CustomOutput">
|
||
<summary>
|
||
Spec for custom output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomOutput.RawOutputs">
|
||
<summary>
|
||
Output only. List of raw output strings.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.CustomOutputFormatConfig">
|
||
<summary>
|
||
Spec for custom output format configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.CustomOutputFormatConfig.ReturnRawOutput">
|
||
<summary>
|
||
Optional. Whether to return raw output.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Dataset">
|
||
<summary>
|
||
A collection of DataItems and Annotations on them.
|
||
</summary>
|
||
<summary>
|
||
Dataset for training or validation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.CreateTime">
|
||
<summary>
|
||
Output only. Timestamp when this Dataset was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.DataItemCount">
|
||
<summary>
|
||
Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.Description">
|
||
<summary>
|
||
The description of the Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.DisplayName">
|
||
<summary>
|
||
Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.EncryptionSpec">
|
||
<summary>
|
||
Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.Etag">
|
||
<summary>
|
||
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.Labels">
|
||
<summary>
|
||
The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset: * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.Metadata">
|
||
<summary>
|
||
Required. Additional information about the Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.MetadataArtifact">
|
||
<summary>
|
||
Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is <c>projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.MetadataSchemaUri">
|
||
<summary>
|
||
Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.ModelReference">
|
||
<summary>
|
||
Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.Name">
|
||
<summary>
|
||
Output only. Identifier. The resource name of the Dataset. Format: <c>projects/{project}/locations/{location}/datasets/{dataset}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.SatisfiesPzi">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.SatisfiesPzs">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.SavedQueries">
|
||
<summary>
|
||
All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.UpdateTime">
|
||
<summary>
|
||
Output only. Timestamp when this Dataset was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Dataset.Examples">
|
||
<summary>
|
||
Optional. Inline examples with simple input/output text.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DatasetDistribution">
|
||
<summary>
|
||
Distribution computed over a tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.Buckets">
|
||
<summary>
|
||
Output only. Defines the histogram bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.Max">
|
||
<summary>
|
||
Output only. The maximum of the population values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.Mean">
|
||
<summary>
|
||
Output only. The arithmetic mean of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.Median">
|
||
<summary>
|
||
Output only. The median of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.Min">
|
||
<summary>
|
||
Output only. The minimum of the population values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.P5">
|
||
<summary>
|
||
Output only. The 5th percentile of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.P95">
|
||
<summary>
|
||
Output only. The 95th percentile of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistribution.Sum">
|
||
<summary>
|
||
Output only. Sum of a given population of values.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DatasetDistributionDistributionBucket">
|
||
<summary>
|
||
Dataset bucket used to create a histogram for the distribution given a population of values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistributionDistributionBucket.Count">
|
||
<summary>
|
||
Output only. Number of values in the bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistributionDistributionBucket.Left">
|
||
<summary>
|
||
Output only. Left bound of the bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetDistributionDistributionBucket.Right">
|
||
<summary>
|
||
Output only. Right bound of the bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DatasetStats">
|
||
<summary>
|
||
Statistics computed over a tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.DroppedExampleIndices">
|
||
<summary>
|
||
Output only. A partial sample of the indices (starting from 1) of the dropped examples.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.DroppedExampleReasons">
|
||
<summary>
|
||
Output only. For each index in <c>dropped_example_indices</c>, the user-facing reason why the example was dropped.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.TotalBillableCharacterCount">
|
||
<summary>
|
||
Output only. Number of billable characters in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.TotalTuningCharacterCount">
|
||
<summary>
|
||
Output only. Number of tuning characters in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.TuningDatasetExampleCount">
|
||
<summary>
|
||
Output only. Number of examples in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.TuningStepCount">
|
||
<summary>
|
||
Output only. Number of tuning steps for this Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.UserDatasetExamples">
|
||
<summary>
|
||
Output only. Sample user messages in the training dataset uri.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.UserInputTokenDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the user input tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.UserMessagePerExampleDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the messages per example.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DatasetStats.UserOutputTokenDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the user output tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DateTimeFormatJsonConverter">
|
||
<summary>
|
||
Custom DateTime JSON converter to serialize and deserialize ISO 8601 format without nanoseconds.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.DateTimeFormatJsonConverter.#ctor(System.String)">
|
||
<summary>
|
||
Custom DateTime JSON converter to serialize and deserialize ISO 8601 format without nanoseconds.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.DateTimeFormatJsonConverter.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
|
||
<inheritdoc cref="T:System.Text.Json.Serialization.JsonConverter"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.DateTimeFormatJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.DateTime,System.Text.Json.JsonSerializerOptions)">
|
||
<inheritdoc cref="T:System.Text.Json.Serialization.JsonConverter"/>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DebugConfig">
|
||
<summary>
|
||
Configuration options that change client network behavior when testing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DebugConfig.ClientMode">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DebugConfig.ReplayId">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DebugConfig.ReplaysDirectory">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DeleteChunkRequest">
|
||
<summary>
|
||
Request to delete a <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DeleteChunkRequest.Name">
|
||
<summary>
|
||
Required. The resource name of the <see cref="T:Mscc.GenerativeAI.Types.Chunk"/> to delete. Example: <see cref="!:corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk"/>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DeployedModelRef">
|
||
<summary>
|
||
Points to a DeployedModel.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DeployedModelRef.CheckpointId">
|
||
<summary>
|
||
Immutable. The ID of the Checkpoint deployed in the DeployedModel.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DeployedModelRef.DeployedModelId">
|
||
<summary>
|
||
Immutable. An ID of a DeployedModel in the above Endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DeployedModelRef.Endpoint">
|
||
<summary>
|
||
Immutable. A resource name of an Endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DeploymentResourcesType">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DiffChecksumsResponse">
|
||
<summary>
|
||
Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffChecksumsResponse.ObjectVersion">
|
||
<summary>
|
||
The object version of the object the checksums are being returned for.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffChecksumsResponse.ObjectSizeBytes">
|
||
<summary>
|
||
The total size of the server object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffChecksumsResponse.ChunkSizeBytes">
|
||
<summary>
|
||
The chunk size of checksums. Must be a multiple of 256KB.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffChecksumsResponse.ObjectLocation">
|
||
<summary>
|
||
If set, calculate the checksums based on the contents and return them to the caller.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffChecksumsResponse.ChecksumsLocation">
|
||
<summary>
|
||
Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DiffDownloadResponse">
|
||
<summary>
|
||
Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffDownloadResponse.ObjectLocation">
|
||
<summary>
|
||
The original object location.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DiffUploadRequest">
|
||
<summary>
|
||
A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffUploadRequest.ObjectVersion">
|
||
<summary>
|
||
The object version of the object that is the base version the
|
||
incoming diff script will be applied to. This field will always be filled in.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffUploadRequest.ObjectInfo">
|
||
<summary>
|
||
The location of the new object.
|
||
Agents must clone the object located here, as the upload server
|
||
will delete the contents once a response is received.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffUploadRequest.ChecksumsInfo">
|
||
<summary>
|
||
The location of the checksums for the new object.
|
||
Agents must clone the object located here, as the upload server
|
||
will delete the contents once a response is received.
|
||
For details on the format of the checksums, see http://go/scotty-diff-protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DiffUploadResponse">
|
||
<summary>
|
||
Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffUploadResponse.ObjectVersion">
|
||
<summary>
|
||
The object version of the object at the server.
|
||
Must be included in the end notification response.
|
||
The version in the end notification response must correspond
|
||
to the new version of the object that is now stored at the server, after the upload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffUploadResponse.OriginalObject">
|
||
<summary>
|
||
The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DiffVersionResponse">
|
||
<summary>
|
||
Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffVersionResponse.ObjectVersion">
|
||
<summary>
|
||
The object version of the object the checksums are being returned for.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DiffVersionResponse.ObjectSizeBytes">
|
||
<summary>
|
||
The total size of the server object.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DirectUploadSource">
|
||
<summary>
|
||
The input content is encapsulated and uploaded in the request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DistillationDataStats">
|
||
<summary>
|
||
Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationDataStats.TrainingDatasetStats">
|
||
<summary>
|
||
Output only. Statistics computed for the training dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DistillationHyperParameters">
|
||
<summary>
|
||
Hyperparameters for Distillation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationHyperParameters.AdapterSize">
|
||
<summary>
|
||
Optional. Adapter size for distillation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationHyperParameters.EpochCount">
|
||
<summary>
|
||
Optional. Number of complete passes the model makes over the entire training dataset during training.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationHyperParameters.LearningRateMultiplier">
|
||
<summary>
|
||
Optional. Multiplier for adjusting the default learning rate.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DistillationSpec">
|
||
<summary>
|
||
Tuning Spec for Distillation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationSpec.BaseTeacherModel">
|
||
<summary>
|
||
The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationSpec.HyperParameters">
|
||
<summary>
|
||
Optional. Hyperparameters for Distillation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationSpec.PipelineRootDirectory">
|
||
<summary>
|
||
Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationSpec.StudentModel">
|
||
<summary>
|
||
The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationSpec.TrainingDatasetUri">
|
||
<summary>
|
||
Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationSpec.TunedTeacherModelSource">
|
||
<summary>
|
||
The resource name of the Tuned teacher model. Format: <c>projects/{project}/locations/{location}/models/{model}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistillationSpec.ValidationDatasetUri">
|
||
<summary>
|
||
Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DistributionBucket">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistributionBucket.Count">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistributionBucket.Left">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DistributionBucket.Right">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Document">
|
||
<summary>
|
||
A `Document` is a collection of `Chunk`s.
|
||
</summary>
|
||
<summary>
|
||
A <c>Document</c> is a collection of <c>Chunk</c>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.CreateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <c>Document</c> was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.CustomMetadata">
|
||
<summary>
|
||
Optional. User provided custom metadata stored as key-value pairs used for querying. A <c>Document</c> can have a maximum of 20 <c>CustomMetadata</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.DisplayName">
|
||
<summary>
|
||
Optional. The human-readable display name for the <c>Document</c>. The display name must be no more than 512 characters in length, including spaces. Example: "Semantic Retriever Documentation"
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.MimeType">
|
||
<summary>
|
||
Output only. The mime type of the Document.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.Name">
|
||
<summary>
|
||
Immutable. Identifier. The <c>Document</c> resource name. The ID (name excluding the "fileSearchStores/*/documents/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be derived from <c>display_name</c> along with a 12 character random suffix. Example: <c>fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.SizeBytes">
|
||
<summary>
|
||
Output only. The size of raw bytes ingested into the Document.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.State">
|
||
<summary>
|
||
Output only. Current state of the <c>Document</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Document.UpdateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <c>Document</c> was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Document.StateType.StateUnspecified">
|
||
<summary>
|
||
The default value. This value is used if the state is omitted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Document.StateType.StatePending">
|
||
<summary>
|
||
Some `Chunks` of the `Document` are being processed (embedding and vector storage).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Document.StateType.StateActive">
|
||
<summary>
|
||
All `Chunks` of the `Document` is processed and available for querying.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Document.StateType.StateFailed">
|
||
<summary>
|
||
Some `Chunks` of the `Document` failed processing.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DownloadFileResponse">
|
||
<summary>
|
||
Response for <c>DownloadFile</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DownloadParameters">
|
||
<summary>
|
||
Parameters specific to media downloads.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DownloadParameters.AllowGzipCompression">
|
||
<summary>
|
||
A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DownloadParameters.IgnoreRange">
|
||
<summary>
|
||
Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Duration">
|
||
<summary>
|
||
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution.
|
||
</summary>
|
||
<remarks>
|
||
It is independent of any calendar and concepts like "day" or "month".
|
||
It is related to Timestamp in that the difference between two Timestamp values is a Duration and
|
||
it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.
|
||
<seealso href="https://protobuf.dev/reference/protobuf/google.protobuf/#duration"/>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Duration.Seconds">
|
||
<summary>
|
||
Seconds of a duration.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Duration.Nanos">
|
||
<summary>
|
||
Nano seconds of a duration.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.DynamicRetrievalConfig">
|
||
<summary>
|
||
Describes the options to customize dynamic retrieval.
|
||
</summary>
|
||
<summary>
|
||
Describes the options to customize dynamic retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DynamicRetrievalConfig.DynamicThreshold">
|
||
<summary>
|
||
The threshold to be used in dynamic retrieval. If not set, a system default value is used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.DynamicRetrievalConfig.Mode">
|
||
<summary>
|
||
The mode of the predictor to be used in dynamic retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.DynamicRetrievalConfigMode.ModeUnspecified">
|
||
<summary>
|
||
Always trigger retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.DynamicRetrievalConfigMode.ModeDynamic">
|
||
<summary>
|
||
Run retrieval only when system decides it is necessary.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EditImageConfig">
|
||
<summary>
|
||
Edit config object for model versions 006 and greater. All editConfig subfields are optional. If not specified, the default editing mode is inpainting.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EditImageConfig.EditMode">
|
||
<summary>
|
||
Optional. Describes the editing mode for the request. One editing mode per request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EditImageConfig.MaskMode">
|
||
<summary>
|
||
Optional.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EditImageConfig.MaskDilation">
|
||
<summary>
|
||
Optional. Determines the dilation percentage of the mask provided.
|
||
</summary>
|
||
<remarks>0.03 (3%) is the default value of shortest side. Minimum: 0, Maximum: 1</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EditImageConfig.ProductPosition">
|
||
<summary>
|
||
Optional. Defines whether the detected product should stay fixed or be repositioned. If you set this field, you must also set "editMode": "product-image".
|
||
</summary>
|
||
<remarks>Values:
|
||
reposition - Lets the model move the location of the detected product or object. (default value)
|
||
fixed - The model maintains the original positioning of the detected product or object
|
||
If the input image is not square, the model defaults to reposition.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EditImageRequest">
|
||
<summary>
|
||
Request for image editing.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.EditImageRequest.#ctor(System.String,System.Nullable{System.Int32})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.EditImageRequest"/> class.
|
||
</summary>
|
||
<param name="prompt">A text description of the edit to apply to the image.</param>
|
||
<param name="sampleCount">The number of generated images.</param>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EditImageResponse">
|
||
<summary>
|
||
Response for the request to edit an image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EditImageResponse.Images">
|
||
<summary>
|
||
Output only. A list of the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EditImageResponse.GeneratedImages">
|
||
<summary>
|
||
List of generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EditMode">
|
||
<summary>
|
||
A list of reasons why content may have been blocked.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeDefault">
|
||
<summary>
|
||
Default editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeBgswap">
|
||
<summary>
|
||
Background swap editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeControlledEditing">
|
||
<summary>
|
||
Controlled editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeInpaintInsertion">
|
||
<summary>
|
||
Inpainting insertion editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeInpaintRemoval">
|
||
<summary>
|
||
Inpainting removal editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeOutpaint">
|
||
<summary>
|
||
Outpainting editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeProductImage">
|
||
<summary>
|
||
Product image editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EditMode.EditModeStyle">
|
||
<summary>
|
||
Style editing mode.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedContentBatch">
|
||
<summary>
|
||
A resource representing a batch of <c>EmbedContent</c> requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.BatchStats">
|
||
<summary>
|
||
Output only. Stats about the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.CreateTime">
|
||
<summary>
|
||
Output only. The time at which the batch was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.DisplayName">
|
||
<summary>
|
||
Required. The user-defined name of this batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.EndTime">
|
||
<summary>
|
||
Output only. The time at which the batch processing completed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.InputConfig">
|
||
<summary>
|
||
Required. Input configuration of the instances on which batch processing are performed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.Model">
|
||
<summary>
|
||
Required. The name of the <c>Model</c> to use for generating the completion. Format: <c>models/{model}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.Name">
|
||
<summary>
|
||
Output only. Identifier. Resource name of the batch. Format: <c>batches/{batch_id}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.Output">
|
||
<summary>
|
||
Output only. The output of the batch request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.Priority">
|
||
<summary>
|
||
Optional. The priority of the batch. Batches with a higher priority value will be processed before batches with a lower priority value. Negative values are allowed. Default is 0.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.State">
|
||
<summary>
|
||
Output only. The state of the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatch.UpdateTime">
|
||
<summary>
|
||
Output only. The time at which the batch was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EmbedContentBatch.StateType.BatchStateUnspecified">
|
||
<summary>
|
||
The batch state is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EmbedContentBatch.StateType.BatchStatePending">
|
||
<summary>
|
||
The service is preparing to run the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EmbedContentBatch.StateType.BatchStateRunning">
|
||
<summary>
|
||
The batch is in progress.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EmbedContentBatch.StateType.BatchStateSucceeded">
|
||
<summary>
|
||
The batch completed successfully.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EmbedContentBatch.StateType.BatchStateFailed">
|
||
<summary>
|
||
The batch failed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EmbedContentBatch.StateType.BatchStateCancelled">
|
||
<summary>
|
||
The batch has been cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.EmbedContentBatch.StateType.BatchStateExpired">
|
||
<summary>
|
||
The batch has expired.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedContentBatchOutput">
|
||
<summary>
|
||
The output of a batch request. This is returned in the <c>AsyncBatchEmbedContentResponse</c> or the <c>EmbedContentBatch.output</c> field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatchOutput.InlinedResponses">
|
||
<summary>
|
||
Output only. The responses to the requests in the batch. Returned when the batch was built using inlined requests. The responses will be in the same order as the input requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatchOutput.ResponsesFile">
|
||
<summary>
|
||
Output only. The file ID of the file containing the responses. The file will be a JSONL file with a single response per line. The responses will be <c>EmbedContentResponse</c> messages formatted as JSON. The responses will be written in the same order as the input requests.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedContentBatchStats">
|
||
<summary>
|
||
Stats about the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatchStats.FailedRequestCount">
|
||
<summary>
|
||
Output only. The number of requests that failed to be processed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatchStats.PendingRequestCount">
|
||
<summary>
|
||
Output only. The number of requests that are still pending processing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatchStats.RequestCount">
|
||
<summary>
|
||
Output only. The number of requests in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentBatchStats.SuccessfulRequestCount">
|
||
<summary>
|
||
Output only. The number of requests that were successfully processed.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedContentConfig">
|
||
<summary>
|
||
Optional parameters for the embed_content method.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentConfig.AutoTruncate">
|
||
<summary>
|
||
Vertex API only. Whether to silently truncate inputs longer than the max sequence length. If this option is set to false, oversized inputs will lead to an INVALID_ARGUMENT error, similar to other text APIs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentConfig.MimeType">
|
||
<summary>
|
||
Vertex API only. The MIME type of the input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentConfig.OutputDimensionality">
|
||
<summary>
|
||
Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. Supported by newer models since 2024 only. You cannot set this value if using the earlier model (models/embedding-001).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentConfig.TaskType">
|
||
<summary>
|
||
Type of task for which the embedding will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentConfig.Title">
|
||
<summary>
|
||
Title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedContentRequest">
|
||
<summary>
|
||
Request message for PredictionService.EmbedContent.
|
||
</summary>
|
||
<summary>
|
||
Request containing the <see cref="P:Mscc.GenerativeAI.Types.EmbedContentRequest.Content"/> for the model to embed.
|
||
</summary>
|
||
<summary>
|
||
Request containing the <c>Content</c> for the model to embed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentRequest.AutoTruncate">
|
||
<summary>
|
||
Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentRequest.Content">
|
||
<summary>
|
||
Required. The content to embed. Only the <see cref="!:parts.text"/> fields will be counted.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.EmbedContentRequest.#ctor">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.EmbedContentRequest.#ctor(System.String)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="prompt"></param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.EmbedContentRequest.#ctor(System.Collections.Generic.List{System.String})">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="prompts"></param>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentRequest.Model">
|
||
<summary>
|
||
Required. The model's resource name. This serves as an ID for the Model to use. This name should match a model name returned by the <c>ListModels</c> method. Format: <c>models/{model}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentRequest.OutputDimensionality">
|
||
<summary>
|
||
Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. Supported by newer models since 2024 only. You cannot set this value if using the earlier model (<c>models/embedding-001</c>).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentRequest.TaskType">
|
||
<summary>
|
||
Optional. Optional task type for which the embeddings will be used. Not supported on earlier models (<c>models/embedding-001</c>).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentRequest.Title">
|
||
<summary>
|
||
Optional. An optional title for the text. Only applicable when TaskType is <c>RETRIEVAL_DOCUMENT</c>. Note: Specifying a <c>title</c> for <c>RETRIEVAL_DOCUMENT</c> provides better quality embeddings for retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedContentResponse">
|
||
<summary>
|
||
Response message for PredictionService.EmbedContent.
|
||
</summary>
|
||
<summary>
|
||
The response to an <see cref="T:Mscc.GenerativeAI.Types.EmbedContentRequest"/>.
|
||
</summary>
|
||
<summary>
|
||
The response to an <c>EmbedContentRequest</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentResponse.Truncated">
|
||
<summary>
|
||
Whether the input content was truncated before generating the embedding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentResponse.UsageMetadata">
|
||
<summary>
|
||
Metadata about the response(s).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentResponse.Candidates">
|
||
<summary>
|
||
Output only. Generated candidates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentResponse.Embeddings">
|
||
<summary>
|
||
Output only. The embeddings for each request, in the same order as provided in the batch request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedContentResponse.Embedding">
|
||
<summary>
|
||
Output only. The embedding generated from the input content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Embedding">
|
||
<summary>
|
||
A list of floats representing the embedding.
|
||
</summary>
|
||
<summary>
|
||
A list of floats representing the embedding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Embedding.Value">
|
||
<summary>
|
||
The embedding values.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedTextRequest">
|
||
<summary>
|
||
Request to get a text embedding from the model.
|
||
</summary>
|
||
<summary>
|
||
Request to get a text embedding from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.EmbedTextRequest.#ctor">
|
||
<summary>
|
||
Default constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.EmbedTextRequest.#ctor(System.String)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="text">Optional. The free-form input text that the model will turn into an embedding.</param>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedTextRequest.Model">
|
||
<summary>
|
||
Required. The model name to use with the format model=models/{model}.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedTextRequest.Text">
|
||
<summary>
|
||
Optional. The free-form input text that the model will turn into an embedding.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EmbedTextResponse">
|
||
<summary>
|
||
The response to a EmbedTextRequest.
|
||
</summary>
|
||
<summary>
|
||
The response to a EmbedTextRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedTextResponse.Embeddings">
|
||
<summary>
|
||
Output only. The embeddings generated from the input text.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EmbedTextResponse.Embedding">
|
||
<summary>
|
||
Output only. The embedding generated from the input text.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Empty">
|
||
<summary>
|
||
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
|
||
</summary>
|
||
<summary>
|
||
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EncryptionSpec">
|
||
<summary>
|
||
Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EncryptionSpec.KmsKeyName">
|
||
<summary>
|
||
Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format <c>projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EnterpriseWebSearch">
|
||
<summary>
|
||
Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.
|
||
</summary>
|
||
<summary>
|
||
Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EnterpriseWebSearch.BlockingConfidence">
|
||
<summary>
|
||
Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EnterpriseWebSearch.ExcludeDomains">
|
||
<summary>
|
||
Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EnterpriseWebSearch.TimeRangeFilter">
|
||
<summary>
|
||
Optional. Filter search results to a specific time range. If customers set a start time,
|
||
they must set an end time (and vice versa). This field is not supported in Vertex AI.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EnvVar">
|
||
<summary>
|
||
Represents an environment variable present in a Container or Python Module.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EnvVar.Name">
|
||
<summary>
|
||
Required. Name of the environment variable. Must be a valid C identifier.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EnvVar.Value">
|
||
<summary>
|
||
Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EvaluateDatasetResponse">
|
||
<summary>
|
||
The results from an evaluation run performed by the EvaluationService.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluateDatasetResponse.AggregationOutput">
|
||
<summary>
|
||
Output only. Aggregation statistics derived from results of EvaluationService.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluateDatasetResponse.OutputInfo">
|
||
<summary>
|
||
Output only. Output info for EvaluationService.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EvaluateDatasetRun">
|
||
<summary>
|
||
Evaluate Dataset Run Result for Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluateDatasetRun.CheckpointId">
|
||
<summary>
|
||
Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluateDatasetRun.Error">
|
||
<summary>
|
||
Output only. The error of the evaluation run if any.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluateDatasetRun.EvaluateDatasetResponse">
|
||
<summary>
|
||
Output only. Results for EvaluationService.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluateDatasetRun.EvaluationRun">
|
||
<summary>
|
||
Output only. The resource name of the evaluation run. Format: <c>projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluateDatasetRun.OperationName">
|
||
<summary>
|
||
Output only. The operation ID of the evaluation run. Format: <c>projects/{project}/locations/{location}/operations/{operation_id}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EvaluationConfig">
|
||
<summary>
|
||
Evaluation Config for Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluationConfig.AutoraterConfig">
|
||
<summary>
|
||
Optional. Autorater config for evaluation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluationConfig.InferenceGenerationConfig">
|
||
<summary>
|
||
Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluationConfig.Metrics">
|
||
<summary>
|
||
Required. The metrics used for evaluation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluationConfig.OutputConfig">
|
||
<summary>
|
||
Required. Config for evaluation output.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.EvaluationDataset">
|
||
<summary>
|
||
The dataset used for evaluation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluationDataset.BigquerySource">
|
||
<summary>
|
||
BigQuery source holds the dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.EvaluationDataset.GcsSource">
|
||
<summary>
|
||
Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExactMatchMetricValue">
|
||
<summary>
|
||
Exact match metric value for an instance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExactMatchMetricValue.Score">
|
||
<summary>
|
||
Output only. Exact match score.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExactMatchSpec">
|
||
<summary>
|
||
Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Example">
|
||
<summary>
|
||
An input/output example used to instruct the Model. It demonstrates how the model should respond or format its response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Example.CreateTime">
|
||
<summary>
|
||
Output only. Timestamp when this Example was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Example.DisplayName">
|
||
<summary>
|
||
Optional. The display name for Example.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Example.ExampleId">
|
||
<summary>
|
||
Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Example.StoredContentsExample">
|
||
<summary>
|
||
An example of chat history and its expected outcome to be used with GenerateContent.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Example.Input">
|
||
<summary>
|
||
Required. An example of an input <c>Message</c> from the user.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Example.Output">
|
||
<summary>
|
||
Required. An example of what the model should output given the input.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Examples">
|
||
<summary>
|
||
Example-based explainability that returns the nearest neighbors from the provided dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Examples.ExampleGcsSource">
|
||
<summary>
|
||
The Cloud Storage input instances.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Examples.GcsSource">
|
||
<summary>
|
||
The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Examples.NearestNeighborSearchConfig">
|
||
<summary>
|
||
The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Examples.NeighborCount">
|
||
<summary>
|
||
The number of neighbors to return when querying for examples.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Examples.Presets">
|
||
<summary>
|
||
Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExamplesExampleGcsSource">
|
||
<summary>
|
||
The Cloud Storage input instances.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExamplesExampleGcsSource.DataFormat">
|
||
<summary>
|
||
The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExamplesExampleGcsSource.GcsSource">
|
||
<summary>
|
||
The Cloud Storage location for the input instances.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ExamplesExampleGcsSource.DataFormatType.DataFormatUnspecified">
|
||
<summary>
|
||
Format unspecified, used when unset.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ExamplesExampleGcsSource.DataFormatType.Jsonl">
|
||
<summary>
|
||
Examples are stored in JSONL files.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExecutableCode">
|
||
<summary>
|
||
Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated.
|
||
</summary>
|
||
<summary>
|
||
Code generated by the model that is meant to be executed, and the result returned to the model. Only generated when using the <see cref="T:Mscc.GenerativeAI.Types.CodeExecution"/> tool, in which the code will be automatically executed, and a corresponding <see cref="T:Mscc.GenerativeAI.Types.CodeExecutionResult"/> will also be generated.
|
||
</summary>
|
||
<summary>
|
||
Code generated by the model that is meant to be executed, and the result returned to the model. Only generated when using the <c>CodeExecution</c> tool, in which the code will be automatically executed, and a corresponding <c>CodeExecutionResult</c> will also be generated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExecutableCode.Code">
|
||
<summary>
|
||
Required. The code to be executed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExecutableCode.Language">
|
||
<summary>
|
||
Required. Programming language of the <c>code</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ExecutableCode.LanguageType.LanguageUnspecified">
|
||
<summary>
|
||
Unspecified language. This value should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ExecutableCode.LanguageType.Python">
|
||
<summary>
|
||
Python >= 3.10, with numpy and simpy available. Python is the default language.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExplanationMetadata">
|
||
<summary>
|
||
Metadata describing the Model's input and output for explanation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationMetadata.FeatureAttributionsSchemaUri">
|
||
<summary>
|
||
Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationMetadata.Inputs">
|
||
<summary>
|
||
Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationMetadata.LatentSpaceSource">
|
||
<summary>
|
||
Name of the source to generate embeddings for example based explanations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationMetadata.Outputs">
|
||
<summary>
|
||
Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExplanationParameters">
|
||
<summary>
|
||
Parameters to configure explaining for Model's predictions.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationParameters.Examples">
|
||
<summary>
|
||
Example-based explanations that returns the nearest neighbors from the provided dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationParameters.IntegratedGradientsAttribution">
|
||
<summary>
|
||
An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationParameters.OutputIndices">
|
||
<summary>
|
||
If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationParameters.SampledShapleyAttribution">
|
||
<summary>
|
||
An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationParameters.TopK">
|
||
<summary>
|
||
If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationParameters.XraiAttribution">
|
||
<summary>
|
||
An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExplanationSpec">
|
||
<summary>
|
||
Specification of Model explanation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationSpec.Metadata">
|
||
<summary>
|
||
Optional. Metadata describing the Model's input and output for explanation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExplanationSpec.Parameters">
|
||
<summary>
|
||
Required. Parameters that configure explaining of the Model's predictions.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExternalApi">
|
||
<summary>
|
||
Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApi.ApiAuth">
|
||
<summary>
|
||
The authentication config to access the API. Deprecated. Please use auth_config instead.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApi.ApiSpec">
|
||
<summary>
|
||
The API spec that the external API implements.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApi.AuthConfig">
|
||
<summary>
|
||
The authentication config to access the API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApi.ElasticSearchParams">
|
||
<summary>
|
||
Parameters for the elastic search API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApi.Endpoint">
|
||
<summary>
|
||
The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApi.SimpleSearchParams">
|
||
<summary>
|
||
Parameters for the simple search API.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ExternalApi.ApiSpecType.ApiSpecUnspecified">
|
||
<summary>
|
||
Unspecified API spec. This value should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ExternalApi.ApiSpecType.SimpleSearch">
|
||
<summary>
|
||
Simple search API spec.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ExternalApi.ApiSpecType.ElasticSearch">
|
||
<summary>
|
||
Elastic search API spec.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExternalApiElasticSearchParams">
|
||
<summary>
|
||
The search parameters to use for the ELASTIC_SEARCH spec.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApiElasticSearchParams.Index">
|
||
<summary>
|
||
The ElasticSearch index to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApiElasticSearchParams.NumHits">
|
||
<summary>
|
||
Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the <c>num_hits</c> param.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ExternalApiElasticSearchParams.SearchTemplate">
|
||
<summary>
|
||
The ElasticSearch search template to use.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ExternalApiSimpleSearchParams">
|
||
<summary>
|
||
The search parameters to use for SIMPLE_SEARCH spec.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FeatureNoiseSigma">
|
||
<summary>
|
||
Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FeatureNoiseSigma.NoiseSigma">
|
||
<summary>
|
||
Noise sigma per feature. No noise is added to features that are not set.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FeatureNoiseSigmaNoiseSigmaForFeature">
|
||
<summary>
|
||
Noise sigma for a single feature.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FeatureNoiseSigmaNoiseSigmaForFeature.Name">
|
||
<summary>
|
||
The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FeatureNoiseSigmaNoiseSigmaForFeature.Sigma">
|
||
<summary>
|
||
This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FileData">
|
||
<summary>
|
||
URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.
|
||
</summary>
|
||
<summary>
|
||
URI based data.
|
||
</summary>
|
||
<summary>
|
||
URI based data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileData.DisplayName">
|
||
<summary>
|
||
Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in <c>PromptMessage</c> for prompt management. It is used in the Gemini calls only when server side tools (<c>code_execution</c>, <c>google_search</c>, and <c>url_context</c>) are enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileData.FileUri">
|
||
<summary>
|
||
Required. URI.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileData.MimeType">
|
||
<summary>
|
||
Optional. The IANA standard MIME type of the source data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileRequest.DisplayName">
|
||
<summary>
|
||
Optional. The human-readable display name for the File. The display name must be no more than 512 characters in length, including spaces. Example: "Welcome Image"
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileRequest.Name">
|
||
<summary>
|
||
Optional. The resource name of the File to create.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FileResource">
|
||
<summary>
|
||
A file resource of the File API.
|
||
</summary>
|
||
<summary>
|
||
A file uploaded to the API. Next ID: 15
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.CreateTime">
|
||
<summary>
|
||
Output only. The timestamp of when the <c>File</c> was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.DisplayName">
|
||
<summary>
|
||
Optional. The human-readable display name for the <c>File</c>. The display name must be no more than 512 characters in length, including spaces. Example: "Welcome Image"
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.DownloadUri">
|
||
<summary>
|
||
Output only. The download uri of the <c>File</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.Error">
|
||
<summary>
|
||
Output only. Error status if File processing failed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.ExpirationTime">
|
||
<summary>
|
||
Output only. The timestamp of when the <c>File</c> will be deleted. Only set if the <c>File</c> is scheduled to expire.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.MimeType">
|
||
<summary>
|
||
Output only. MIME type of the file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.Name">
|
||
<summary>
|
||
Immutable. Identifier. The <c>File</c> resource name. The ID (name excluding the "files/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be generated. Example: <c>files/123-456</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.Sha256Hash">
|
||
<summary>
|
||
Output only. SHA-256 hash of the uploaded bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.SizeBytes">
|
||
<summary>
|
||
Output only. Size of the file in bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.Source">
|
||
<summary>
|
||
Source of the File.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.State">
|
||
<summary>
|
||
Output only. Processing state of the File.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.UpdateTime">
|
||
<summary>
|
||
Output only. The timestamp of when the <c>File</c> was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.Uri">
|
||
<summary>
|
||
Output only. The uri of the <c>File</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileResource.VideoMetadata">
|
||
<summary>
|
||
Output only. Metadata for a video.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.SourceType.SourceUnspecified">
|
||
<summary>
|
||
Used if source is not specified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.SourceType.Uploaded">
|
||
<summary>
|
||
Indicates the file is uploaded by the user.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.SourceType.Generated">
|
||
<summary>
|
||
Indicates the file is generated by Google.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.SourceType.Registered">
|
||
<summary>
|
||
Indicates the file is a registered, i.e. a Google Cloud Storage file.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.StateType.StateUnspecified">
|
||
<summary>
|
||
The default value. This value is used if the state is omitted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.StateType.Processing">
|
||
<summary>
|
||
File is being processed and cannot be used for inference yet.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.StateType.Active">
|
||
<summary>
|
||
File is processed and available for inference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResource.StateType.Failed">
|
||
<summary>
|
||
File failed processing.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FileResourceSource">
|
||
<summary>
|
||
Source of the File.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResourceSource.SourceUnspecified">
|
||
<summary>
|
||
Used if source is not specified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResourceSource.Uploaded">
|
||
<summary>
|
||
Indicates the file is uploaded by the user.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResourceSource.Generated">
|
||
<summary>
|
||
Indicates the file is generated by Google.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileResourceSource.Registered">
|
||
<summary>
|
||
Indicates the file is a registered, i.e. a Google Cloud Storage file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FileSearch">
|
||
<summary>
|
||
The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora.
|
||
Files are imported to Semantic Retrieval corpora using the ImportFile API.
|
||
</summary>
|
||
<summary>
|
||
The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora. Files are imported to Semantic Retrieval corpora using the ImportFile API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearch.RetrievalConfig">
|
||
<summary>
|
||
Optional. The configuration for the retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearch.RetrievalResources">
|
||
<summary>
|
||
Required. Semantic retrieval resources to retrieve from. Currently only supports one corpus.
|
||
In the future we may open up multiple corpora support.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearch.Stores">
|
||
<summary>
|
||
Convenience property.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearch.Filter">
|
||
<summary>
|
||
Convenience property.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearch.FileSearchStoreNames">
|
||
<summary>
|
||
Required. The names of the file_search_stores to retrieve from. Example: <c>fileSearchStores/my-file-search-store-123</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearch.MetadataFilter">
|
||
<summary>
|
||
Optional. Metadata filter to apply to the semantic retrieval documents and chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearch.TopK">
|
||
<summary>
|
||
Optional. The number of semantic retrieval chunks to retrieve.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FileSearchRetrievalConfig">
|
||
<summary>
|
||
Semantic retrieval configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchRetrievalConfig.MetadataFilter">
|
||
<summary>
|
||
Optional. Metadata filter to apply to the semantic retrieval documents and chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchRetrievalConfig.TopK">
|
||
<summary>
|
||
Optional. The number of semantic retrieval chunks to retrieve.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FileSearchStore">
|
||
<summary>
|
||
A <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> is a collection of <see cref="T:Mscc.GenerativeAI.Types.Document"/>s.
|
||
</summary>
|
||
<summary>
|
||
A <c>FileSearchStore</c> is a collection of <c>Document</c>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.ActiveDocumentsCount">
|
||
<summary>
|
||
Output only. The number of documents in the <c>FileSearchStore</c> that are active and ready for retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.CreateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <c>FileSearchStore</c> was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.DisplayName">
|
||
<summary>
|
||
Optional. The human-readable display name for the <c>FileSearchStore</c>. The display name must be no more than 512 characters in length, including spaces. Example: "Docs on Semantic Retriever"
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.FailedDocumentsCount">
|
||
<summary>
|
||
Output only. The number of documents in the <c>FileSearchStore</c> that have failed processing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.Name">
|
||
<summary>
|
||
Output only. Immutable. Identifier. The <c>FileSearchStore</c> resource name. It is an ID (name excluding the "fileSearchStores/" prefix) that can contain up to 40 characters that are lowercase alphanumeric or dashes (-). It is output only. The unique name will be derived from <c>display_name</c> along with a 12 character random suffix. Example: <c>fileSearchStores/my-awesome-file-search-store-123a456b789c</c> If <c>display_name</c> is not provided, the name will be randomly generated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.PendingDocumentsCount">
|
||
<summary>
|
||
Output only. The number of documents in the <c>FileSearchStore</c> that are being processed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.SizeBytes">
|
||
<summary>
|
||
Output only. The size of raw bytes ingested into the <c>FileSearchStore</c>. This is the total size of all the documents in the <c>FileSearchStore</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileSearchStore.UpdateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the <c>FileSearchStore</c> was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FileStatus">
|
||
<summary>
|
||
RagFile status.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileStatus.ErrorStatus">
|
||
<summary>
|
||
Output only. Only when the <c>state</c> field is ERROR.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FileStatus.State">
|
||
<summary>
|
||
Output only. RagFile state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileStatus.StateType.StateUnspecified">
|
||
<summary>
|
||
RagFile state is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileStatus.StateType.Active">
|
||
<summary>
|
||
RagFile resource has been created and indexed successfully.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FileStatus.StateType.Error">
|
||
<summary>
|
||
RagFile resource is in a problematic state. See `error_message` field for details.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Filter.MetadataFilter">
|
||
<summary>
|
||
Optional. String for metadata filtering.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Filter.VectorDistanceThreshold">
|
||
<summary>
|
||
Optional. Only returns contexts with vector distance smaller than the threshold.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Filter.VectorSimilarityThreshold">
|
||
<summary>
|
||
Optional. Only returns contexts with vector similarity larger than the threshold.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.FinishReasonUnspecified">
|
||
<summary>
|
||
Default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.Stop">
|
||
<summary>
|
||
Natural stop point of the model or provided stop sequence.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.MaxTokens">
|
||
<summary>
|
||
The maximum number of tokens as specified in the request was reached.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.Safety">
|
||
<summary>
|
||
The response candidate content was flagged for safety reasons.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.Recitation">
|
||
<summary>
|
||
The response candidate content was flagged for recitation reasons.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.Language">
|
||
<summary>
|
||
The response candidate content was flagged for using an unsupported language.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.Other">
|
||
<summary>
|
||
Unknown reason.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.Blocklist">
|
||
<summary>
|
||
Token generation stopped because the content contains forbidden terms.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.ProhibitedContent">
|
||
<summary>
|
||
Token generation stopped for potentially containing prohibited content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.Spii">
|
||
<summary>
|
||
Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.MalformedFunctionCall">
|
||
<summary>
|
||
The function call generated by the model is invalid.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.ImageSafety">
|
||
<summary>
|
||
Token generation stopped because generated images contain safety violations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.ImageProhibitedContent">
|
||
<summary>
|
||
Image generation stopped because generated images has other prohibited content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.ImageOther">
|
||
<summary>
|
||
Image generation stopped because of other miscellaneous issue.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.NoImage">
|
||
<summary>
|
||
The model was expected to generate an image, but none was generated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.ImageRecitation">
|
||
<summary>
|
||
Image generation stopped due to recitation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.UnexpectedToolCall">
|
||
<summary>
|
||
Model generated a tool call but no tools were enabled in the request.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.TooManyToolCalls">
|
||
<summary>
|
||
Model called too many tools consecutively, thus the system exited execution.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.MissingThoughtSignature">
|
||
<summary>
|
||
Request has at least one thought signature missing.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FinishReason.MalformedResponse">
|
||
<summary>
|
||
Finished due to malformed response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FullFineTuningSpec">
|
||
<summary>
|
||
Tuning Spec for Full Fine Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FullFineTuningSpec.HyperParameters">
|
||
<summary>
|
||
Optional. Hyperparameters for Full Fine Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FullFineTuningSpec.TrainingDatasetUri">
|
||
<summary>
|
||
Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FullFineTuningSpec.ValidationDatasetUri">
|
||
<summary>
|
||
Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FunctionCall">
|
||
<summary>
|
||
A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.
|
||
</summary>
|
||
<summary>
|
||
A predicted <see cref="T:Mscc.GenerativeAI.Types.FunctionCall"/> returned from the model that contains a string representing the <see cref="!:FunctionDeclaration.name"/> with the arguments and their values.
|
||
</summary>
|
||
<summary>
|
||
A predicted <c>FunctionCall</c> returned from the model that contains a string representing the <c>FunctionDeclaration.name</c> with the arguments and their values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCall.PartialArgs">
|
||
<summary>
|
||
Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCall.WillContinue">
|
||
<summary>
|
||
Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCall.Args">
|
||
<summary>
|
||
Optional. The function parameters and values in JSON object format.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCall.Id">
|
||
<summary>
|
||
Optional. Unique identifier of the function call. If populated, the client to execute the <c>function_call</c> and return the response with the matching <c>id</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCall.Name">
|
||
<summary>
|
||
Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FunctionCallingConfig">
|
||
<summary>
|
||
Function calling config.
|
||
</summary>
|
||
<summary>
|
||
Configuration for specifying function calling behavior.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCallingConfig.StreamFunctionCallArguments">
|
||
<summary>
|
||
Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the [FunctionCall.partial_args] field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCallingConfig.AllowedFunctionNames">
|
||
<summary>
|
||
Optional. A set of function names that, when provided, limits the functions the model will call. This should only be set when the Mode is ANY or VALIDATED. Function names should match [FunctionDeclaration.name]. When set, model will predict a function call from only allowed function names.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionCallingConfig.Mode">
|
||
<summary>
|
||
Optional. Specifies the mode in which function calling should execute. If unspecified, the default value will be set to AUTO.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionCallingConfigMode.ModeUnspecified">
|
||
<summary>
|
||
Unspecified function calling mode. This value should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionCallingConfigMode.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.Types.FunctionCallingConfigMode.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.Types.FunctionCallingConfigMode.None">
|
||
<summary>
|
||
Model will not predict any function call. Model behavior is same as when not passing any function declarations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionCallingConfigMode.Validated">
|
||
<summary>
|
||
Model decides to predict either a function call or a natural language response, but will validate function calls with constrained decoding. 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="T:Mscc.GenerativeAI.Types.FunctionDeclaration">
|
||
<summary>
|
||
Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a <c>Tool</c> by the model and executed by the client.
|
||
</summary>
|
||
<summary>
|
||
Structured representation of a function declaration as defined by the OpenAPI 3.03 specification. Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.
|
||
</summary>
|
||
<summary>
|
||
Structured representation of a function declaration as defined by the [OpenAPI 3.03 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a <c>Tool</c> by the model and executed by the client.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionDeclaration.Behavior">
|
||
<summary>
|
||
Optional. Specifies the function Behavior. Currently only supported by the BidiGenerateContent method.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionDeclaration.Description">
|
||
<summary>
|
||
Required. A brief description of the function.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionDeclaration.Name">
|
||
<summary>
|
||
Required. The name of the function. Must be a-z, A-Z, 0-9, or contain underscores, colons, dots, and dashes, with a maximum length of 64.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionDeclaration.Parameters">
|
||
<summary>
|
||
Optional. Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionDeclaration.ParametersJsonSchema">
|
||
<summary>
|
||
Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``<c> { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } </c>`<c> This field is mutually exclusive with </c>parameters`.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionDeclaration.Response">
|
||
<summary>
|
||
Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionDeclaration.ResponseJsonSchema">
|
||
<summary>
|
||
Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with <c>response</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionDeclaration.BehaviorType.Unspecified">
|
||
<summary>
|
||
This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionDeclaration.BehaviorType.Blocking">
|
||
<summary>
|
||
If set, the system will wait to receive the function response before continuing the conversation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionDeclaration.BehaviorType.NonBlocking">
|
||
<summary>
|
||
If set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FunctionResponse">
|
||
<summary>
|
||
The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.
|
||
</summary>
|
||
<summary>
|
||
The result output from a <see cref="T:Mscc.GenerativeAI.Types.FunctionCall"/> that contains a string representing the <see cref="!:FunctionDeclaration.name"/> and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a<see cref="T:Mscc.GenerativeAI.Types.FunctionCall"/> made based on model prediction.
|
||
</summary>
|
||
<summary>
|
||
The result output from a <c>FunctionCall</c> that contains a string representing the <c>FunctionDeclaration.name</c> and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a<c>FunctionCall</c> made based on model prediction.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponse.Id">
|
||
<summary>
|
||
Optional. The identifier of the function call this response is for. Populated by the client to match the corresponding function call <c>id</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponse.Name">
|
||
<summary>
|
||
Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponse.Parts">
|
||
<summary>
|
||
Optional. Ordered <c>Parts</c> that constitute a function response. Parts may have different IANA MIME types.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponse.Response">
|
||
<summary>
|
||
Required. The function response in JSON object format. Callers can use any keys of their choice that fit the function's syntax to return the function output, e.g. "output", "result", etc. In particular, if the function call failed to execute, the response can have an "error" key to return error details to the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponse.Scheduling">
|
||
<summary>
|
||
Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponse.WillContinue">
|
||
<summary>
|
||
Optional. Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty <c>response</c> with <c>will_continue=False</c> to signal that the function call is finished. This may still trigger the model generation. To avoid triggering the generation and finish the function call, additionally set <c>scheduling</c> to <c>SILENT</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionResponse.SchedulingType.SchedulingUnspecified">
|
||
<summary>
|
||
This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionResponse.SchedulingType.Silent">
|
||
<summary>
|
||
Only add the result to the conversation context, do not interrupt or trigger generation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionResponse.SchedulingType.WhenIdle">
|
||
<summary>
|
||
Add the result to the conversation context, and prompt to generate output without interrupting ongoing generation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.FunctionResponse.SchedulingType.Interrupt">
|
||
<summary>
|
||
Add the result to the conversation context, interrupt ongoing generation and prompt to generate output.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FunctionResponseBlob">
|
||
<summary>
|
||
Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.
|
||
</summary>
|
||
<summary>
|
||
Raw media bytes for function response. Text should not be sent as raw bytes, use the 'FunctionResponse.response' field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponseBlob.DisplayName">
|
||
<summary>
|
||
Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponseBlob.Data">
|
||
<summary>
|
||
Raw bytes for media formats.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponseBlob.MimeType">
|
||
<summary>
|
||
The IANA standard MIME type of the source data. Examples: - image/png - image/jpeg If an unsupported MIME type is provided, an error will be returned. For a complete list of supported types, see [Supported file formats](https://ai.google.dev/gemini-api/docs/prompting_with_media#supported_file_formats).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FunctionResponseFileData">
|
||
<summary>
|
||
URI based data for function response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponseFileData.DisplayName">
|
||
<summary>
|
||
Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponseFileData.FileUri">
|
||
<summary>
|
||
Required. URI.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponseFileData.MimeType">
|
||
<summary>
|
||
Required. The IANA standard MIME type of the source data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.FunctionResponsePart">
|
||
<summary>
|
||
A datatype containing media that is part of a <c>FunctionResponse</c> message. A <c>FunctionResponsePart</c> consists of data which has an associated datatype. A <c>FunctionResponsePart</c> can only contain one of the accepted types in <c>FunctionResponsePart.data</c>. A <c>FunctionResponsePart</c> must have a fixed IANA MIME type identifying the type and subtype of the media if the <c>inline_data</c> field is filled with raw bytes.
|
||
</summary>
|
||
<summary>
|
||
A datatype containing media that is part of a <see cref="T:Mscc.GenerativeAI.Types.FunctionResponse"/> message. A <see cref="T:Mscc.GenerativeAI.Types.FunctionResponsePart"/> consists of data which has an associated datatype. A <see cref="T:Mscc.GenerativeAI.Types.FunctionResponsePart"/> can only contain one of the accepted types in <see cref="!:FunctionResponsePart.data"/>. A <see cref="T:Mscc.GenerativeAI.Types.FunctionResponsePart"/> must have a fixed IANA MIME type identifying the type and subtype of the media if the <see cref="!:inline_data"/> field is filled with raw bytes.
|
||
</summary>
|
||
<summary>
|
||
A datatype containing media that is part of a <c>FunctionResponse</c> message. A <c>FunctionResponsePart</c> consists of data which has an associated datatype. A <c>FunctionResponsePart</c> can only contain one of the accepted types in <c>FunctionResponsePart.data</c>. A <c>FunctionResponsePart</c> must have a fixed IANA MIME type identifying the type and subtype of the media if the <c>inline_data</c> field is filled with raw bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponsePart.FileData">
|
||
<summary>
|
||
URI based data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.FunctionResponsePart.InlineData">
|
||
<summary>
|
||
Inline media bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GcsDestination">
|
||
<summary>
|
||
The Google Cloud Storage location where the output is to be written to.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GcsDestination.OutputUriPrefix">
|
||
<summary>
|
||
Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GcsSource">
|
||
<summary>
|
||
The Google Cloud Storage location for the input content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GcsSource.Uris">
|
||
<summary>
|
||
Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GeminiPreferenceExample">
|
||
<summary>
|
||
Input example for preference optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeminiPreferenceExample.Completions">
|
||
<summary>
|
||
List of completions for a given prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeminiPreferenceExample.Contents">
|
||
<summary>
|
||
Multi-turn contents that represents the Prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GeminiPreferenceExampleCompletion">
|
||
<summary>
|
||
Completion and its preference score.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeminiPreferenceExampleCompletion.Completion">
|
||
<summary>
|
||
Single turn completion for the given prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeminiPreferenceExampleCompletion.Score">
|
||
<summary>
|
||
The score for the given completion.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateAnswerRequest">
|
||
<summary>
|
||
Request to generate a grounded answer from the model.
|
||
</summary>
|
||
<summary>
|
||
Request to generate a grounded answer from the <c>Model</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateAnswerRequest.#ctor">
|
||
<summary>
|
||
Default constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerRequest.AnswerStyle">
|
||
<summary>
|
||
Required. Style in which answers should be returned.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerRequest.Contents">
|
||
<summary>
|
||
Required. The content of the current conversation with the <c>Model</c>. For single-turn queries, this is a single question to answer. For multi-turn queries, this is a repeated field that contains conversation history and the last <c>Content</c> in the list containing the question. Note: <c>GenerateAnswer</c> only supports queries in English.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerRequest.InlinePassages">
|
||
<summary>
|
||
Passages provided inline with the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerRequest.SafetySettings">
|
||
<summary>
|
||
Optional. A list of unique <c>SafetySetting</c> instances for blocking unsafe content. This will be enforced on the <c>GenerateAnswerRequest.contents</c> and <c>GenerateAnswerResponse.candidate</c>. There should not be more than one setting for each <c>SafetyCategory</c> type. The API will block any contents and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each <c>SafetyCategory</c> specified in the safety_settings. If there is no <c>SafetySetting</c> for a given <c>SafetyCategory</c> provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT are supported. Refer to the [guide](https://ai.google.dev/gemini-api/docs/safety-settings) for detailed information on available safety settings. Also refer to the [Safety guidance](https://ai.google.dev/gemini-api/docs/safety-guidance) to learn how to incorporate safety considerations in your AI applications.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerRequest.SemanticRetriever">
|
||
<summary>
|
||
Content retrieved from resources created via the Semantic Retriever API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerRequest.Temperature">
|
||
<summary>
|
||
Optional. Controls the randomness of the output. Values can range from [0.0,1.0], inclusive. A value closer to 1.0 will produce responses that are more varied and creative, while a value closer to 0.0 will typically result in more straightforward responses from the model. A low temperature (~0.2) is usually recommended for Attributed-Question-Answering use cases.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateAnswerResponse">
|
||
<summary>
|
||
Response from the model for a grounded answer.
|
||
</summary>
|
||
<summary>
|
||
Response from the model for a grounded answer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerResponse.Text">
|
||
<summary>
|
||
Responded text information of first candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateAnswerResponse.ToString">
|
||
<summary>
|
||
A convenience overload to easily access the responded text.
|
||
</summary>
|
||
<returns>The responded text information of first candidate.</returns>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerResponse.Answer">
|
||
<summary>
|
||
Candidate answer from the model. Note: The model *always* attempts to provide a grounded answer, even when the answer is unlikely to be answerable from the given passages. In that case, a low-quality or ungrounded answer may be provided, along with a low <c>answerable_probability</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerResponse.AnswerableProbability">
|
||
<summary>
|
||
Output only. The model's estimate of the probability that its answer is correct and grounded in the input passages. A low <c>answerable_probability</c> indicates that the answer might not be grounded in the sources. When <c>answerable_probability</c> is low, you may want to: * Display a message to the effect of "We couldn’t answer that question" to the user. * Fall back to a general-purpose LLM that answers the question from world knowledge. The threshold and nature of such fallbacks will depend on individual use cases. <c>0.5</c> is a good starting threshold.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateAnswerResponse.InputFeedback">
|
||
<summary>
|
||
Output only. Feedback related to the input data used to answer the question, as opposed to the model-generated response to the question. The input data can be one or more of the following: - Question specified by the last entry in <c>GenerateAnswerRequest.content</c> - Conversation history specified by the other entries in <c>GenerateAnswerRequest.content</c> - Grounding sources (<c>GenerateAnswerRequest.semantic_retriever</c> or <c>GenerateAnswerRequest.inline_passages</c>)
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateContentBatch">
|
||
<summary>
|
||
A resource representing a batch of <c>GenerateContent</c> requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.BatchStats">
|
||
<summary>
|
||
Output only. Stats about the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.CreateTime">
|
||
<summary>
|
||
Output only. The time at which the batch was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.DisplayName">
|
||
<summary>
|
||
Required. The user-defined name of this batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.EndTime">
|
||
<summary>
|
||
Output only. The time at which the batch processing completed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.InputConfig">
|
||
<summary>
|
||
Required. Input configuration of the instances on which batch processing are performed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.Model">
|
||
<summary>
|
||
Required. The name of the <c>Model</c> to use for generating the completion. Format: <c>models/{model}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.Name">
|
||
<summary>
|
||
Output only. Identifier. Resource name of the batch. Format: <c>batches/{batch_id}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.Output">
|
||
<summary>
|
||
Output only. The output of the batch request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.Priority">
|
||
<summary>
|
||
Optional. The priority of the batch. Batches with a higher priority value will be processed before batches with a lower priority value. Negative values are allowed. Default is 0.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.State">
|
||
<summary>
|
||
Output only. The state of the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatch.UpdateTime">
|
||
<summary>
|
||
Output only. The time at which the batch was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentBatch.StateType.BatchStateUnspecified">
|
||
<summary>
|
||
The batch state is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentBatch.StateType.BatchStatePending">
|
||
<summary>
|
||
The service is preparing to run the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentBatch.StateType.BatchStateRunning">
|
||
<summary>
|
||
The batch is in progress.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentBatch.StateType.BatchStateSucceeded">
|
||
<summary>
|
||
The batch completed successfully.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentBatch.StateType.BatchStateFailed">
|
||
<summary>
|
||
The batch failed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentBatch.StateType.BatchStateCancelled">
|
||
<summary>
|
||
The batch has been cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentBatch.StateType.BatchStateExpired">
|
||
<summary>
|
||
The batch has expired.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateContentBatchOutput">
|
||
<summary>
|
||
The output of a batch request. This is returned in the <c>BatchGenerateContentResponse</c> or the <c>GenerateContentBatch.output</c> field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatchOutput.InlinedResponses">
|
||
<summary>
|
||
Output only. The responses to the requests in the batch. Returned when the batch was built using inlined requests. The responses will be in the same order as the input requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentBatchOutput.ResponsesFile">
|
||
<summary>
|
||
Output only. The file ID of the file containing the responses. The file will be a JSONL file with a single response per line. The responses will be <c>GenerateContentResponse</c> messages formatted as JSON. The responses will be written in the same order as the input requests.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateContentConfig">
|
||
<summary>
|
||
Optional model configuration parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.AudioTimestamp">
|
||
<summary>
|
||
If enabled, audio timestamp will be included in the request to the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.AutomaticFunctionCalling">
|
||
<summary>
|
||
The configuration for automatic function calling.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.CachedContent">
|
||
<summary>
|
||
Resource name of a context cache that can be used in subsequent requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.Labels">
|
||
<summary>
|
||
Labels with user-defined metadata to break down billed charges.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.RoutingConfig">
|
||
<summary>
|
||
Configuration for model router requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.SafetySettings">
|
||
<summary>
|
||
Safety settings in the request to block unsafe content in the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.SystemInstruction">
|
||
<summary>
|
||
Instructions for the model to steer it toward better performance. For example, “Answer as concisely as possible” or “Don’t use technical terms in your response”.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.ToolConfig">
|
||
<summary>
|
||
Associates model output to a specific function call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentConfig.Tools">
|
||
<summary>
|
||
Code that enables the system to interact with external systems to perform an action outside of the knowledge and scope of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateContentRequest">
|
||
<summary>
|
||
Request message for [PredictionService.GenerateContent].
|
||
</summary>
|
||
<summary>
|
||
Request to generate a completion from the model.
|
||
</summary>
|
||
<summary>
|
||
Request to generate a completion from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.ModelArmorConfig">
|
||
<summary>
|
||
Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.ETag">
|
||
<summary>
|
||
The ETag of the item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.Labels">
|
||
<summary>
|
||
Optional. The labels with user-defined metadata for the request.
|
||
</summary>
|
||
<remarks>
|
||
It is used for billing and reporting only.
|
||
Label keys and values can be no longer than 63 characters (Unicode codepoints) and
|
||
can only contain lowercase letters, numeric characters, underscores, and dashes.
|
||
International characters are allowed. Label values are optional. Label keys must start with a letter.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateContentRequest"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.#ctor(System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Mscc.GenerativeAI.Types.ToolConfig)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateContentRequest"/> class.
|
||
</summary>
|
||
<param name="prompt">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="systemInstruction">Optional. </param>
|
||
<param name="toolConfig">Optional. Configuration of tools.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.#ctor(System.Collections.Generic.List{Mscc.GenerativeAI.Types.IPart},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Mscc.GenerativeAI.Types.ToolConfig)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateContentRequest"/> class.
|
||
</summary>
|
||
<param name="parts"></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>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="parts"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.#ctor(Mscc.GenerativeAI.Types.FileResource,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Mscc.GenerativeAI.Types.ToolConfig)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateContentRequest"/> class.
|
||
</summary>
|
||
<param name="file">The media file resource.</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>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.#ctor(System.Collections.Generic.List{Mscc.GenerativeAI.Types.Part},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Mscc.GenerativeAI.Types.ToolConfig)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateContentRequest"/> class.
|
||
</summary>
|
||
<param name="parts"></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>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="parts"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.AddContent(Mscc.GenerativeAI.Types.Content)">
|
||
<summary>
|
||
Adds a <see cref="T:Mscc.GenerativeAI.Types.Content"/> object to the request.
|
||
</summary>
|
||
<param name="content"></param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.AddMedia(System.String,System.String,System.Boolean)">
|
||
<summary>
|
||
Adds a media file or a base64-encoded string to the request.
|
||
</summary>
|
||
<remarks>
|
||
Depending on the <paramref name="useOnline"/> flag, either an <see cref="T:Mscc.GenerativeAI.Types.InlineData"/>
|
||
or <see cref="T:Mscc.GenerativeAI.Types.FileData"/> part will be added to the request.
|
||
Standard URLs are supported and the resource is downloaded if <paramref name="useOnline"/> is <see langword="false"/>.
|
||
</remarks>
|
||
<param name="uri">The URI of the media file.</param>
|
||
<param name="mimeType">The IANA standard MIME type to check.</param>
|
||
<param name="useOnline">Flag indicating whether the file shall be used online or read from the local file system.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="uri"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.AddMedia(Mscc.GenerativeAI.Types.FileResource)">
|
||
<summary>
|
||
Adds a media file resource to the request.
|
||
</summary>
|
||
<param name="file">The media file resource.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the MIME type of <paramref name="file"/>> is not supported by the API.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentRequest.AddPart(Mscc.GenerativeAI.Types.IPart,System.Int32)">
|
||
<summary>
|
||
Adds a <see cref="T:Mscc.GenerativeAI.Types.Part"/> object to the Content at the specified <param name="index"></param>.
|
||
</summary>
|
||
<param name="part">Part object to add to the <see cref="P:Mscc.GenerativeAI.Types.GenerateContentRequest.Contents"/> collection.</param>
|
||
<param name="index">Zero-based index of element in the Contents collection.</param>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.CachedContent">
|
||
<summary>
|
||
Optional. The name of the content [cached](https://ai.google.dev/gemini-api/docs/caching) to use as context to serve the prediction. Format: <c>cachedContents/{cachedContent}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.Contents">
|
||
<summary>
|
||
Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries like [chat](https://ai.google.dev/gemini-api/docs/text-generation#chat), this is a repeated field that contains the conversation history and the latest request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.GenerationConfig">
|
||
<summary>
|
||
Optional. Configuration options for model generation and outputs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.Model">
|
||
<summary>
|
||
Required. The name of the <c>Model</c> to use for generating the completion. Format: <c>models/{model}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.SafetySettings">
|
||
<summary>
|
||
Optional. A list of unique <c>SafetySetting</c> instances for blocking unsafe content. This will be enforced on the <c>GenerateContentRequest.contents</c> and <c>GenerateContentResponse.candidates</c>. There should not be more than one setting for each <c>SafetyCategory</c> type. The API will block any contents and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each <c>SafetyCategory</c> specified in the safety_settings. If there is no <c>SafetySetting</c> for a given <c>SafetyCategory</c> provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY are supported. Refer to the [guide](https://ai.google.dev/gemini-api/docs/safety-settings) for detailed information on available safety settings. Also refer to the [Safety guidance](https://ai.google.dev/gemini-api/docs/safety-guidance) to learn how to incorporate safety considerations in your AI applications.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.SystemInstruction">
|
||
<summary>
|
||
Optional. Developer set [system instruction(s)](https://ai.google.dev/gemini-api/docs/system-instructions). Currently, text only.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.ToolConfig">
|
||
<summary>
|
||
Optional. Tool configuration for any <c>Tool</c> specified in the request. Refer to the [Function calling guide](https://ai.google.dev/gemini-api/docs/function-calling#function_calling_mode) for a usage example.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentRequest.Tools">
|
||
<summary>
|
||
Optional. A list of <c>Tools</c> the <c>Model</c> may use to generate the next response. A <c>Tool</c> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the <c>Model</c>. Supported <c>Tool</c>s are <c>Function</c> and <c>code_execution</c>. Refer to the [Function calling](https://ai.google.dev/gemini-api/docs/function-calling) and the [Code execution](https://ai.google.dev/gemini-api/docs/code-execution) guides to learn more.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateContentResponse">
|
||
<summary>
|
||
Response message for [PredictionService.GenerateContent].
|
||
</summary>
|
||
<summary>
|
||
Response from the model supporting multiple candidates.
|
||
Ref: https://ai.google.dev/api/rest/v1beta/GenerateContentResponse
|
||
</summary>
|
||
<summary>
|
||
Response from the model supporting multiple candidate responses. Safety ratings and content filtering are reported for both prompt in <c>GenerateContentResponse.prompt_feedback</c> and for each candidate in <c>finish_reason</c> and in <c>safety_ratings</c>. The API: - Returns either all requested candidates or none of them - Returns no candidates at all only if there was something wrong with the prompt (check <c>prompt_feedback</c>) - Reports feedback on each candidate in <c>finish_reason</c> and <c>safety_ratings</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.CreateTime">
|
||
<summary>
|
||
Output only. Timestamp when the request is made to the server.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.Text">
|
||
<summary>
|
||
A convenience property to get the responded text information of first candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.FunctionCalls">
|
||
<summary>
|
||
A convenience property to get the function calls.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.Thinking">
|
||
<summary>
|
||
A convenience property to get the responded thinking information of first candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentResponse.#ctor">
|
||
<summary>
|
||
Default constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentResponse.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Base constructor to set the <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateContentResponse.ToString">
|
||
<summary>
|
||
A convenience overload to easily access the responded text.
|
||
</summary>
|
||
<returns>The responded text information of first candidate.</returns>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.Candidates">
|
||
<summary>
|
||
Candidate responses from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.ModelStatus">
|
||
<summary>
|
||
Output only. The current model status of this model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.ModelVersion">
|
||
<summary>
|
||
Output only. The model version used to generate the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.PromptFeedback">
|
||
<summary>
|
||
Returns the prompt's feedback related to the content filters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.ResponseId">
|
||
<summary>
|
||
Output only. response_id is used to identify each response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponse.UsageMetadata">
|
||
<summary>
|
||
Output only. Metadata on the generation requests' token usage.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateContentResponsePromptFeedback">
|
||
<summary>
|
||
Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponsePromptFeedback.BlockReason">
|
||
<summary>
|
||
Output only. The reason why the prompt was blocked.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponsePromptFeedback.BlockReasonMessage">
|
||
<summary>
|
||
Output only. A readable message that explains the reason why the prompt was blocked.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponsePromptFeedback.SafetyRatings">
|
||
<summary>
|
||
Output only. A list of safety ratings for the prompt. There is one rating per category.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata">
|
||
<summary>
|
||
Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.CacheTokensDetails">
|
||
<summary>
|
||
Output only. A detailed breakdown of the token count for each modality in the cached content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.CachedContentTokenCount">
|
||
<summary>
|
||
Output only. The number of tokens in the cached content that was used for this request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.CandidatesTokenCount">
|
||
<summary>
|
||
The total number of tokens in the generated candidates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.CandidatesTokensDetails">
|
||
<summary>
|
||
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.PromptTokenCount">
|
||
<summary>
|
||
The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When <c>cached_content</c> is set, this also includes the number of tokens in the cached content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.PromptTokensDetails">
|
||
<summary>
|
||
Output only. A detailed breakdown of the token count for each modality in the prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.ThoughtsTokenCount">
|
||
<summary>
|
||
Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.ToolUsePromptTokenCount">
|
||
<summary>
|
||
Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.ToolUsePromptTokensDetails">
|
||
<summary>
|
||
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.TotalTokenCount">
|
||
<summary>
|
||
The total number of tokens for the entire request. This is the sum of <c>prompt_token_count</c>, <c>candidates_token_count</c>, <c>tool_use_prompt_token_count</c>, and <c>thoughts_token_count</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.TrafficType">
|
||
<summary>
|
||
Output only. The traffic type for this request.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.GenerateContentResponseUsageMetadataTrafficType.TrafficTypeUnspecified">
|
||
<summary>
|
||
Unspecified request traffic type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.GenerateContentResponseUsageMetadataTrafficType.OnDemand">
|
||
<summary>
|
||
The request was processed using Pay-As-You-Go quota.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.GenerateContentResponseUsageMetadataTrafficType.OnDemandPriority">
|
||
<summary>
|
||
Type for Priority Pay-As-You-Go traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.GenerateContentResponseUsageMetadataTrafficType.OnDemandFlex">
|
||
<summary>
|
||
Type for Flex traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerateContentResponseUsageMetadata.GenerateContentResponseUsageMetadataTrafficType.ProvisionedThroughput">
|
||
<summary>
|
||
Type for Provisioned Throughput traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GeneratedFile">
|
||
<summary>
|
||
A file generated on behalf of a user.
|
||
</summary>
|
||
<summary>
|
||
A file generated on behalf of a user.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedFile.Blob">
|
||
<summary>
|
||
The blob reference of the generated file to download.
|
||
Only set when the GeneratedFiles.get request url has the \"?alt=media\" query param.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedFile.Error">
|
||
<summary>
|
||
Error details if the GeneratedFile ends up in the STATE_FAILED state.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedFile.MimeType">
|
||
<summary>
|
||
MIME type of the generatedFile.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedFile.Name">
|
||
<summary>
|
||
Identifier. The name of the generated file. Example: <c>generatedFiles/abc-123</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedFile.State">
|
||
<summary>
|
||
Output only. The state of the GeneratedFile.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GeneratedFile.StateType.StateUnspecified">
|
||
<summary>
|
||
The default value. This value is used if the state is omitted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GeneratedFile.StateType.Generating">
|
||
<summary>
|
||
Being generated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GeneratedFile.StateType.Generated">
|
||
<summary>
|
||
Generated and is ready for download.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GeneratedFile.StateType.Failed">
|
||
<summary>
|
||
Failed to generate the GeneratedFile.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GeneratedImage">
|
||
<summary>
|
||
An output image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedImage.Image">
|
||
<summary>
|
||
The output image data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedImage.RaiFilteredReason">
|
||
<summary>
|
||
Responsible AI filter reason if the image is filtered out of the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedImage.EnhancedPrompt">
|
||
<summary>
|
||
The rewritten prompt used for the image generation if the prompt enhancer is enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GeneratedVideo">
|
||
<summary>
|
||
A generated video.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GeneratedVideo.Video">
|
||
<summary>
|
||
The output video
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateEmbeddingsEmbedding">
|
||
<summary>
|
||
An embedding vector generated by the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsEmbedding.Embedding">
|
||
<summary>
|
||
Output only. The embedding vector generated for the input.
|
||
Can be either a list of floats or a base64 string encoding the a list of floats with C-style layout (Numpy compatible).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsEmbedding.Index">
|
||
<summary>
|
||
Output only. Index of the embedding in the list of embeddings.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsEmbedding.Object">
|
||
<summary>
|
||
Output only. Always \"embedding\", required by the SDK.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateEmbeddingsRequest">
|
||
<summary>
|
||
Request for embedding generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsRequest.Model">
|
||
<summary>
|
||
Required. Model to generate the embeddings for.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsRequest.Input">
|
||
<summary>
|
||
Required. The input to generate embeddings for.
|
||
Can be a string, or a list of strings.
|
||
The SDK supports a list of numbers and list of list of numbers, but this is not yet implemented.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsRequest.EncodingFormat">
|
||
<summary>
|
||
Optional. The format of the encoding.
|
||
Must be either \"float\" or \"base64\".
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsRequest.Dimensions">
|
||
<summary>
|
||
Optional. Dimensional size of the generated embeddings.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateEmbeddingsResponse">
|
||
<summary>
|
||
Response for embedding generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsResponse.Model">
|
||
<summary>
|
||
Output only. Model used to generate the embeddings.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsResponse.Object">
|
||
<summary>
|
||
Output only. Always \"embedding\", required by the SDK.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateEmbeddingsResponse.Data">
|
||
<summary>
|
||
Output only. A list of the requested embeddings.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateImagesConfig">
|
||
<summary>
|
||
The config for generating an images.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateImagesRequest">
|
||
<summary>
|
||
Request for image generation.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateImagesRequest.#ctor(System.String,System.Nullable{System.Int32})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateImagesRequest"/> class.
|
||
</summary>
|
||
<param name="prompt">The text prompt guides what images the model generates.</param>
|
||
<param name="sampleCount">The number of generated images.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="sampleCount"/> is less than 1 or greater than 8.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateImagesResponse">
|
||
<summary>
|
||
Response for image generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateImagesResponse.Images">
|
||
<summary>
|
||
Output only. A list of the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateImagesResponse.GeneratedImages">
|
||
<summary>
|
||
List of generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateImagesResponse.Model">
|
||
<summary>
|
||
Output only. Model used to generate the images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateImagesResponse.Object">
|
||
<summary>
|
||
Output only. Always \"image\", required by the SDK.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateMessageRequest">
|
||
<summary>
|
||
Generates a response from the model given an input MessagePrompt.
|
||
</summary>
|
||
<summary>
|
||
Request to generate a message response from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateMessageRequest.#ctor">
|
||
<summary>
|
||
Default constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateMessageRequest.#ctor(System.String)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="prompt"></param>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageRequest.CandidateCount">
|
||
<summary>
|
||
Optional. The number of generated response messages to return. This value must be between <c>[1, 8]</c>, inclusive. If unset, this will default to <c>1</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageRequest.Prompt">
|
||
<summary>
|
||
Required. The structured textual input given to the model as a prompt. Given a prompt, the model will return what it predicts is the next message in the discussion.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageRequest.Temperature">
|
||
<summary>
|
||
Optional. Controls the randomness of the output. Values can range over <c>[0.0,1.0]</c>, inclusive. A value closer to <c>1.0</c> will produce responses that are more varied, while a value closer to <c>0.0</c> will typically result in less surprising responses from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageRequest.TopK">
|
||
<summary>
|
||
Optional. The maximum number of tokens to consider when sampling. The model uses combined Top-k and nucleus sampling. Top-k sampling considers the set of <c>top_k</c> most probable tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageRequest.TopP">
|
||
<summary>
|
||
Optional. The maximum cumulative probability of tokens to consider when sampling. The model uses combined Top-k and nucleus sampling. Nucleus sampling considers the smallest set of tokens whose probability sum is at least <c>top_p</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateMessageResponse">
|
||
<summary>
|
||
The response from the model. This includes candidate messages and conversation history in the form of chronologically-ordered messages.
|
||
</summary>
|
||
<summary>
|
||
The response from the model. This includes candidate messages and conversation history in the form of chronologically-ordered messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageResponse.Text">
|
||
<summary>
|
||
Responded text information of first candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateMessageResponse.ToString">
|
||
<summary>
|
||
A convenience overload to easily access the responded text.
|
||
</summary>
|
||
<returns>The responded text information of first candidate.</returns>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageResponse.Candidates">
|
||
<summary>
|
||
Candidate response messages from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageResponse.Filters">
|
||
<summary>
|
||
A set of content filtering metadata for the prompt and response text. This indicates which <c>SafetyCategory</c>(s) blocked a candidate from this response, the lowest <c>HarmProbability</c> that triggered a block, and the HarmThreshold setting for that category.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateMessageResponse.Messages">
|
||
<summary>
|
||
The conversation history used by the model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateTextRequest">
|
||
<summary>
|
||
Request to generate a text completion response from the model.
|
||
</summary>
|
||
<summary>
|
||
Request to generate a text completion response from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateTextRequest.#ctor">
|
||
<summary>
|
||
Default constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateTextRequest.#ctor(System.String)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="prompt"></param>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.CandidateCount">
|
||
<summary>
|
||
Optional. Number of generated responses to return. This value must be between [1, 8], inclusive. If unset, this will default to 1.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.MaxOutputTokens">
|
||
<summary>
|
||
Optional. The maximum number of tokens to include in a candidate. If unset, this will default to output_token_limit specified in the <c>Model</c> specification.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.Prompt">
|
||
<summary>
|
||
Required. The free-form input text given to the model as a prompt. Given a prompt, the model will generate a TextCompletion response it predicts as the completion of the input text.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.SafetySettings">
|
||
<summary>
|
||
Optional. A list of unique <c>SafetySetting</c> instances for blocking unsafe content. that will be enforced on the <c>GenerateTextRequest.prompt</c> and <c>GenerateTextResponse.candidates</c>. There should not be more than one setting for each <c>SafetyCategory</c> type. The API will block any prompts and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each <c>SafetyCategory</c> specified in the safety_settings. If there is no <c>SafetySetting</c> for a given <c>SafetyCategory</c> provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL, HARM_CATEGORY_DANGEROUS are supported in text service.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.StopSequences">
|
||
<summary>
|
||
The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a stop sequence. The stop sequence will not be included as part of the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.Temperature">
|
||
<summary>
|
||
Optional. Controls the randomness of the output. Note: The default value varies by model, see the <c>Model.temperature</c> attribute of the <c>Model</c> returned the <c>getModel</c> function. Values can range from [0.0,1.0], inclusive. A value closer to 1.0 will produce responses that are more varied and creative, while a value closer to 0.0 will typically result in more straightforward responses from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.TopK">
|
||
<summary>
|
||
Optional. The maximum number of tokens to consider when sampling. The model uses combined Top-k and nucleus sampling. Top-k sampling considers the set of <c>top_k</c> most probable tokens. Defaults to 40. Note: The default value varies by model, see the <c>Model.top_k</c> attribute of the <c>Model</c> returned the <c>getModel</c> function.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextRequest.TopP">
|
||
<summary>
|
||
Optional. The maximum cumulative probability of tokens to consider when sampling. The model uses combined Top-k and nucleus sampling. Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits number of tokens based on the cumulative probability. Note: The default value varies by model, see the <c>Model.top_p</c> attribute of the <c>Model</c> returned the <c>getModel</c> function.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateTextResponse">
|
||
<summary>
|
||
The response from the model, including candidate completions.
|
||
</summary>
|
||
<summary>
|
||
The response from the model, including candidate completions.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextResponse.Text">
|
||
<summary>
|
||
Responded text information of first candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateTextResponse.ToString">
|
||
<summary>
|
||
A convenience overload to easily access the responded text.
|
||
</summary>
|
||
<returns>The responded text information of first candidate.</returns>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextResponse.Candidates">
|
||
<summary>
|
||
Candidate responses from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextResponse.Filters">
|
||
<summary>
|
||
A set of content filtering metadata for the prompt and response text. This indicates which <c>SafetyCategory</c>(s) blocked a candidate from this response, the lowest <c>HarmProbability</c> that triggered a block, and the HarmThreshold setting for that category. This indicates the smallest change to the <c>SafetySettings</c> that would be necessary to unblock at least 1 response. The blocking is configured by the <c>SafetySettings</c> in the request (or the default <c>SafetySettings</c> of the API).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateTextResponse.SafetyFeedback">
|
||
<summary>
|
||
Returns any safety feedback related to content filtering.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateVideosConfig">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.SampleCount">
|
||
<summary>
|
||
Number of output videos.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.NumberOfVideos">
|
||
<summary>
|
||
Number of output videos.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.AspectRatio">
|
||
<summary>
|
||
Optional. The aspect ratio for the generated video. 16:9 (landscape) and 9:16 (portrait) are supported.
|
||
</summary>
|
||
<remarks>Value: 9:16, or 16:9</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.DurationSeconds">
|
||
<summary>
|
||
Duration of the clip for video generation in seconds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.EnhancePrompt">
|
||
<summary>
|
||
Whether to use the prompt rewriting logic.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.Fps">
|
||
<summary>
|
||
Frames per second for video generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.HttpOptions">
|
||
<summary>
|
||
Used to override HTTP request options.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.NegativePrompt">
|
||
<summary>
|
||
Optional field in addition to the text content. Negative prompts can be explicitly stated here to help generate the video.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.OutputGcsUri">
|
||
<summary>
|
||
The GCS bucket where to save the generated videos.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.PersonGeneration">
|
||
<summary>
|
||
Whether allow to generate person videos, and restrict to specific ages. Supported values are: dont_allow, allow_adult.
|
||
</summary>
|
||
<remarks>"personGeneration": "allow_all" is not available in Imagen 2 Editing and is only available to approved users‡ in Imagen 2 Generation.
|
||
Values:
|
||
allow_all: Allow generation of people of all ages.
|
||
allow_adult (default): Allow generation of adults only.
|
||
dont_allow: Disables the inclusion of people or faces in images.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.PubsubTopic">
|
||
<summary>
|
||
The PubSub topic where to publish the video generation progress.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.Resolution">
|
||
<summary>
|
||
The resolution for the generated video. 1280x720, 1920x1080 are supported.
|
||
</summary>
|
||
<remarks>Value: 1280x720, or 1920x1080</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosConfig.Seed">
|
||
<summary>
|
||
The RNG seed. If RNG seed is exactly same for each request with unchanged inputs, the prediction results will be consistent. Otherwise, a random RNG seed will be used each time to produce a different result.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateVideosOperation">
|
||
<summary>
|
||
A video generation operation.\n\nUse the following code to refresh the operation:\n\n```\noperation = client.operations.get(operation)\n```
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosOperation.Name">
|
||
<summary>
|
||
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosOperation.Result">
|
||
<summary>
|
||
The generated videos.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosOperation.Metadata">
|
||
<summary>
|
||
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosOperation.Done">
|
||
<summary>
|
||
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosOperation.Error">
|
||
<summary>
|
||
The error result of the operation in case of failure or cancellation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosOperation.Response">
|
||
<summary>
|
||
The normal response of the operation in case of success.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateVideosRequest">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosRequest.Instances">
|
||
<summary>
|
||
An array that contains the object with video details to get information about.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosRequest.Parameters">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateVideosRequest.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateVideosRequest"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GenerateVideosRequest.#ctor(System.String,System.Nullable{System.Int32})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.GenerateVideosRequest"/> class.
|
||
</summary>
|
||
<param name="prompt">The text prompt guides what videos the model generates.</param>
|
||
<param name="numberOfVideos">The number of generated videos.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="numberOfVideos"/> is less than 1 or greater than 8.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerateVideosResponse">
|
||
<summary>
|
||
Response with generated videos.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosResponse.GeneratedVideos">
|
||
<summary>
|
||
List of the generated videos
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosResponse.RaiMediaFilteredCount">
|
||
<summary>
|
||
Returns if any videos were filtered due to RAI policies.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerateVideosResponse.RaiMediaFilteredReasons">
|
||
<summary>
|
||
Returns rai failure reasons if any.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerationConfig">
|
||
<summary>
|
||
Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.
|
||
</summary>
|
||
<summary>
|
||
Configuration options for model generation and outputs. Not all parameters are configurable for every model.
|
||
</summary>
|
||
<summary>
|
||
Configuration options for model generation and outputs. Not all parameters are configurable for every model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.AudioTimestamp">
|
||
<summary>
|
||
Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.EnableAffectiveDialog">
|
||
<summary>
|
||
Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ModelConfig">
|
||
<summary>
|
||
Optional. Config for model selection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.RoutingConfig">
|
||
<summary>
|
||
Optional. Routing configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ModelSelectionConfig">
|
||
<summary>
|
||
Optional. Config for model selection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ResponseJsonSchemaOrdered">
|
||
<summary>
|
||
Optional. An internal detail. Use `responseJsonSchema` rather than this field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ThinkingLevel">
|
||
<summary>
|
||
Optional. Controls the maximum depth of the model's internal reasoning process before it produces a response. If not specified, the default is HIGH. Recommended for Gemini 3 or later models. Use with earlier models results in an error.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig._responseJsonSchema">
|
||
<summary>
|
||
Optional. Output schema of the generated response. This is an alternative to <c>response_schema</c> that accepts [JSON Schema](https://json-schema.org/). If set, <c>response_schema</c> must be omitted, but <c>response_mime_type</c> is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - <c>$id</c> - <c>$defs</c> - <c>$ref</c> - <c>$anchor</c> - <c>type</c> - <c>format</c> - <c>title</c> - <c>description</c> - <c>enum</c> (for strings and numbers) - <c>items</c> - <c>prefixItems</c> - <c>minItems</c> - <c>maxItems</c> - <c>minimum</c> - <c>maximum</c> - <c>anyOf</c> - <c>oneOf</c> (interpreted the same as <c>anyOf</c>) - <c>properties</c> - <c>additionalProperties</c> - <c>required</c> The non-standard <c>propertyOrdering</c> property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If <c>$ref</c> is set on a sub-schema, no other properties, except for than those starting as a <c>$</c>, may be set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.CandidateCount">
|
||
<summary>
|
||
Optional. Number of generated responses to return. If unset, this will default to 1. Please note that this doesn't work for previous generation models (Gemini 1.0 family)
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.EnableEnhancedCivicAnswers">
|
||
<summary>
|
||
Optional. Enables enhanced civic answers. It may not be available for all models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.FrequencyPenalty">
|
||
<summary>
|
||
Optional. Frequency penalty applied to the next token's logprobs, multiplied by the number of times each token has been seen in the respponse so far. A positive penalty will discourage the use of tokens that have already been used, proportional to the number of times the token has been used: The more a token is used, the more difficult it is for the model to use that token again increasing the vocabulary of responses. Caution: A _negative_ penalty will encourage the model to reuse tokens proportional to the number of times the token has been used. Small negative values will reduce the vocabulary of a response. Larger negative values will cause the model to start repeating a common token until it hits the max_output_tokens limit.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ImageConfig">
|
||
<summary>
|
||
Optional. Config for image generation. An error will be returned if this field is set for models that don't support these config options.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.Logprobs">
|
||
<summary>
|
||
Optional. Only valid if response_logprobs=True. This sets the number of top logprobs to return at each decoding step in the Candidate.logprobs_result. The number must be in the range of [0, 20].
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.MaxOutputTokens">
|
||
<summary>
|
||
Optional. The maximum number of tokens to include in a response candidate. Note: The default value varies by model, see the <c>Model.output_token_limit</c> attribute of the <c>Model</c> returned from the <c>getModel</c> function.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.MediaResolution">
|
||
<summary>
|
||
Optional. If specified, the media resolution specified will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.PresencePenalty">
|
||
<summary>
|
||
Optional. Presence penalty applied to the next token's logprobs if the token has already been seen in the response. This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequency_penalty for a penalty that increases with each use. A positive penalty will discourage the use of tokens that have already been used in the response, increasing the vocabulary. A negative penalty will encourage the use of tokens that have already been used in the response, decreasing the vocabulary.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ResponseJsonSchema">
|
||
<summary>
|
||
Optional. An internal detail. Use <c>responseJsonSchema</c> rather than this field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ResponseLogprobs">
|
||
<summary>
|
||
Optional. If true, export the logprobs results in response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ResponseMimeType">
|
||
<summary>
|
||
Optional. MIME type of the generated candidate text. Supported MIME types are: <c>text/plain</c>: (default) Text output. <c>application/json</c>: JSON response in the response candidates. <c>text/x.enum</c>: ENUM as a string response in the response candidates. Refer to the [docs](https://ai.google.dev/gemini-api/docs/prompting_with_media#plain_text_formats) for a list of all supported text MIME types.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ResponseModalities">
|
||
<summary>
|
||
Optional. The requested modalities of the response. Represents the set of modalities that the model can return, and should be expected in the response. This is an exact match to the modalities of the response. A model may have multiple combinations of supported modalities. If the requested modalities do not match any of the supported combinations, an error will be returned. An empty list is equivalent to requesting only text.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ResponseSchema">
|
||
<summary>
|
||
Optional. Output schema of the generated candidate text. Schemas must be a subset of the [OpenAPI schema](https://spec.openapis.org/oas/v3.0.3#schema) and can be objects, primitives or arrays. If set, a compatible <c>response_mime_type</c> must also be set. Compatible MIME types: <c>application/json</c>: Schema for JSON response. Refer to the [JSON text generation guide](https://ai.google.dev/gemini-api/docs/json-mode) for more details.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.Seed">
|
||
<summary>
|
||
Optional. Seed used in decoding. If not set, the request uses a randomly generated seed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.SpeechConfig">
|
||
<summary>
|
||
Optional. The speech generation config.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.StopSequences">
|
||
<summary>
|
||
Optional. The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a <c>stop_sequence</c>. The stop sequence will not be included as part of the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.Temperature">
|
||
<summary>
|
||
Optional. Controls the randomness of the output. Note: The default value varies by model, see the <c>Model.temperature</c> attribute of the <c>Model</c> returned from the <c>getModel</c> function. Values can range from [0.0, 2.0].
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.ThinkingConfig">
|
||
<summary>
|
||
Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.TopK">
|
||
<summary>
|
||
Optional. The maximum number of tokens to consider when sampling. Gemini models use Top-p (nucleus) sampling or a combination of Top-k and nucleus sampling. Top-k sampling considers the set of <c>top_k</c> most probable tokens. Models running with nucleus sampling don't allow top_k setting. Note: The default value varies by <c>Model</c> and is specified by the<c>Model.top_p</c> attribute returned from the <c>getModel</c> function. An empty <c>top_k</c> attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting <c>top_k</c> on requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfig.TopP">
|
||
<summary>
|
||
Optional. The maximum cumulative probability of tokens to consider when sampling. The model uses combined Top-k and Top-p (nucleus) sampling. Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits the number of tokens based on the cumulative probability. Note: The default value varies by <c>Model</c> and is specified by the<c>Model.top_p</c> attribute returned from the <c>getModel</c> function. An empty <c>top_k</c> attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting <c>top_k</c> on requests.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfig.MediaResolutionType.MediaResolutionUnspecified">
|
||
<summary>
|
||
Media resolution has not been set.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfig.MediaResolutionType.MediaResolutionLow">
|
||
<summary>
|
||
Media resolution set to low (64 tokens).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfig.MediaResolutionType.MediaResolutionMedium">
|
||
<summary>
|
||
Media resolution set to medium (256 tokens).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfig.MediaResolutionType.MediaResolutionHigh">
|
||
<summary>
|
||
Media resolution set to high (zoomed reframing with 256 tokens).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerationConfigModelConfig">
|
||
<summary>
|
||
Config for model selection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfigModelConfig.FeatureSelectionPreference">
|
||
<summary>
|
||
Required. Feature selection preference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigModelConfig.FeatureSelectionPreferenceType.FeatureSelectionPreferenceUnspecified">
|
||
<summary>
|
||
Unspecified feature selection preference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigModelConfig.FeatureSelectionPreferenceType.PrioritizeQuality">
|
||
<summary>
|
||
Prefer higher quality over lower cost.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigModelConfig.FeatureSelectionPreferenceType.Balanced">
|
||
<summary>
|
||
Balanced feature selection preference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigModelConfig.FeatureSelectionPreferenceType.PrioritizeCost">
|
||
<summary>
|
||
Prefer lower cost over higher quality.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfig">
|
||
<summary>
|
||
The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfig.AutoMode">
|
||
<summary>
|
||
In this mode, the model is selected automatically based on the content of the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfig.ManualMode">
|
||
<summary>
|
||
In this mode, the model is specified manually.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigAutoRoutingMode">
|
||
<summary>
|
||
The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigAutoRoutingMode.ModelRoutingPreference">
|
||
<summary>
|
||
The model routing preference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigAutoRoutingMode.ModelRoutingPreferenceType.Unknown">
|
||
<summary>
|
||
Unspecified model routing preference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigAutoRoutingMode.ModelRoutingPreferenceType.PrioritizeQuality">
|
||
<summary>
|
||
The model will be selected to prioritize the quality of the response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigAutoRoutingMode.ModelRoutingPreferenceType.Balanced">
|
||
<summary>
|
||
The model will be selected to balance quality and cost.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigAutoRoutingMode.ModelRoutingPreferenceType.PrioritizeCost">
|
||
<summary>
|
||
The model will be selected to prioritize the cost of the request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigManualRoutingMode">
|
||
<summary>
|
||
The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenerationConfigRoutingConfigManualRoutingMode.ModelName">
|
||
<summary>
|
||
The name of the model to use. Only public LLM models are accepted.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenericMetadata">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenericMetadata.CreateTime">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenericMetadata.UpdateTime">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenericOperationMetadata">
|
||
<summary>
|
||
Generic Metadata shared by all operations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenericOperationMetadata.CreateTime">
|
||
<summary>
|
||
Output only. Time when the operation was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenericOperationMetadata.PartialFailures">
|
||
<summary>
|
||
Output only. Partial failures encountered. E.g. single files that couldn't be read. This field should never exceed 20 entries. Status details field will contain standard Google Cloud error details.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenericOperationMetadata.UpdateTime">
|
||
<summary>
|
||
Output only. Time when the operation was updated for the last time. If the operation has finished (successfully or not), this is the finish time.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GenieSource">
|
||
<summary>
|
||
Contains information about the source of the models generated from Generative AI Studio.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GenieSource.BaseModelUri">
|
||
<summary>
|
||
Required. The public base model URI.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleDriveSource">
|
||
<summary>
|
||
The Google Drive location for the input content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleDriveSource.ResourceIds">
|
||
<summary>
|
||
Required. Google Drive resource IDs.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleDriveSourceResourceId">
|
||
<summary>
|
||
The type and ID of the Google Drive resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleDriveSourceResourceId.ResourceId">
|
||
<summary>
|
||
Required. The ID of the Google Drive resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleDriveSourceResourceId.ResourceType">
|
||
<summary>
|
||
Required. The type of the Google Drive resource.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GoogleDriveSourceResourceId.GoogleDriveSourceResourceIdResourceType.ResourceTypeUnspecified">
|
||
<summary>
|
||
Unspecified resource type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GoogleDriveSourceResourceId.GoogleDriveSourceResourceIdResourceType.ResourceTypeFile">
|
||
<summary>
|
||
File resource type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GoogleDriveSourceResourceId.GoogleDriveSourceResourceIdResourceType.ResourceTypeFolder">
|
||
<summary>
|
||
Folder resource type.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleMaps">
|
||
<summary>
|
||
Tool to retrieve public maps data for grounding, powered by Google.
|
||
</summary>
|
||
<summary>
|
||
The GoogleMaps Tool that provides geospatial context for the user's query.
|
||
</summary>
|
||
<summary>
|
||
The GoogleMaps Tool that provides geospatial context for the user's query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleMaps.EnableWidget">
|
||
<summary>
|
||
Optional. Whether to return a widget context token in the GroundingMetadata of the response. Developers can use the widget context token to render a Google Maps widget with geospatial context related to the places that the model references in the response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleMapsChunk">
|
||
<summary>
|
||
A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information
|
||
about a place, such as its name, address, and reviews. This is used to provide the user with
|
||
rich, location-based information. This data type is not supported in Gemini API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleMapsChunk.Uri">
|
||
<summary>
|
||
The URI of the place.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleMapsChunk.Title">
|
||
<summary>
|
||
The title of the place.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleMapsChunk.Text">
|
||
<summary>
|
||
The text of the place answer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleMapsChunk.PlaceId">
|
||
<summary>
|
||
This Place's resource name, in `places/{place_id}` format. This can be used to look up the
|
||
place in the Google Maps API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleMapsChunk.ReviewId">
|
||
<summary>
|
||
A unique identifier for review.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleMapsChunk.PlaceAnswerSources">
|
||
<summary>
|
||
The sources that were used to generate the place answer. This includes review snippets and
|
||
photos that were used to generate the answer, as well as URIs to flag content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleRpcStatus">
|
||
<summary>
|
||
The <c>Status</c> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each <c>Status</c> message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleRpcStatus.Code">
|
||
<summary>
|
||
The status code, which should be an enum value of google.rpc.Code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleRpcStatus.Details">
|
||
<summary>
|
||
A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleRpcStatus.Message">
|
||
<summary>
|
||
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleSearch">
|
||
<summary>
|
||
GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
|
||
</summary>
|
||
<summary>
|
||
GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleSearch.BlockingConfidence">
|
||
<summary>
|
||
Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleSearch.ExcludeDomains">
|
||
<summary>
|
||
Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleSearch.SearchTypes">
|
||
<summary>
|
||
Optional. The set of search types to enable. If not set, web search is enabled by default.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleSearch.TimeRangeFilter">
|
||
<summary>
|
||
Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleSearchRetrieval">
|
||
<summary>
|
||
Tool to retrieve public web data for grounding, powered by Google.
|
||
</summary>
|
||
<summary>
|
||
Tool to retrieve public web data for grounding, powered by Google.
|
||
</summary>
|
||
<summary>
|
||
Tool to retrieve public web data for grounding, powered by Google.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleSearchRetrieval.DisableAttribution">
|
||
<summary>
|
||
Optional. Disable using the result from this tool in detecting grounding attribution.
|
||
</summary>
|
||
<remarks>This does not affect how the result is given to the model for generation.</remarks>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GoogleSearchRetrieval.#ctor">
|
||
<summary>
|
||
Creates an instance of <see cref="T:Mscc.GenerativeAI.Types.GoogleSearchRetrieval"/>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.GoogleSearchRetrieval.#ctor(Mscc.GenerativeAI.Types.DynamicRetrievalConfigMode,System.Single)">
|
||
<summary>
|
||
Creates an instance of <see cref="T:Mscc.GenerativeAI.Types.GoogleSearchRetrieval"/> with Mode and DynamicThreshold.
|
||
</summary>
|
||
<param name="mode">The mode of the predictor to be used in dynamic retrieval.</param>
|
||
<param name="dynamicThreshold">The threshold to be used in dynamic retrieval. If not set, a system default value is used.</param>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleSearchRetrieval.DynamicRetrievalConfig">
|
||
<summary>
|
||
Specifies the dynamic retrieval configuration for the given source.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GoogleTypeDate">
|
||
<summary>
|
||
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleTypeDate.Day">
|
||
<summary>
|
||
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleTypeDate.Month">
|
||
<summary>
|
||
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GoogleTypeDate.Year">
|
||
<summary>
|
||
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GranteeType.GranteeTypeUnspecified">
|
||
<summary>
|
||
The default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GranteeType.User">
|
||
<summary>
|
||
Represents a user. When set, you must provide email_address for the user.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GranteeType.Group">
|
||
<summary>
|
||
Represents a group. When set, you must provide email_address for the group.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.GranteeType.Everyone">
|
||
<summary>
|
||
Represents access to everyone. No extra information is required.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingAttribution">
|
||
<summary>
|
||
Attribution for a source that contributed to an answer.
|
||
</summary>
|
||
<summary>
|
||
Attribution for a source that contributed to an answer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttribution.ConfidenceScore">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttribution.Segment">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttribution.Web">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttribution.Content">
|
||
<summary>
|
||
Grounding source content that makes up this attribution.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttribution.SourceId">
|
||
<summary>
|
||
Output only. Identifier for the source contributing to this attribution.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttributionSegment.StartIndex">
|
||
<summary>
|
||
Output only. Start index into the content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttributionSegment.EndIndex">
|
||
<summary>
|
||
Output only. End index into the content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttributionSegment.PartIndex">
|
||
<summary>
|
||
Output only. Part index into the content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingAttributionWeb">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttributionWeb.Title">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingAttributionWeb.Uri">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingChunk">
|
||
<summary>
|
||
A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a <c>GroundingChunk</c> that contains a reference to the source of the information.
|
||
</summary>
|
||
<summary>
|
||
A <c>GroundingChunk</c> represents a segment of supporting evidence that grounds the model's response. It can be a chunk from the web, a retrieved context from a file, or information from Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingChunk.Image">
|
||
<summary>
|
||
Optional. Grounding chunk from image search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingChunk.Maps">
|
||
<summary>
|
||
Optional. Grounding chunk from Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingChunk.RetrievedContext">
|
||
<summary>
|
||
Optional. Grounding chunk from context retrieved by the file search tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingChunk.Web">
|
||
<summary>
|
||
Grounding chunk from the web.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingMetadata">
|
||
<summary>
|
||
Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.
|
||
</summary>
|
||
<summary>
|
||
Metadata returned to client when grounding is enabled.
|
||
</summary>
|
||
<summary>
|
||
Metadata returned to client when grounding is enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.RetrievalQueries">
|
||
<summary>
|
||
Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.SourceFlaggingUris">
|
||
<summary>
|
||
Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.GroundingAttributions">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.GoogleMapsWidgetContextToken">
|
||
<summary>
|
||
Optional. Resource name of the Google Maps widget context token that can be used with the PlacesContextElement widget in order to render contextual data. Only populated in the case that grounding with Google Maps is enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.GroundingChunks">
|
||
<summary>
|
||
List of supporting references retrieved from specified grounding source. When streaming, this only contains the grounding chunks that have not been included in the grounding metadata of previous responses.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.GroundingSupports">
|
||
<summary>
|
||
List of grounding support.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.ImageSearchQueries">
|
||
<summary>
|
||
Image search queries used for grounding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.RetrievalMetadata">
|
||
<summary>
|
||
Metadata related to retrieval in the grounding flow.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.SearchEntryPoint">
|
||
<summary>
|
||
Optional. Google search entry for the following-up web searches.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadata.WebSearchQueries">
|
||
<summary>
|
||
Web search queries for the following-up web search.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingMetadataSourceFlaggingUri">
|
||
<summary>
|
||
A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadataSourceFlaggingUri.FlagContentUri">
|
||
<summary>
|
||
The URI that can be used to flag the content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingMetadataSourceFlaggingUri.SourceId">
|
||
<summary>
|
||
The ID of the place or review.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingPassage">
|
||
<summary>
|
||
Passage included inline with a grounding configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingPassage.Content">
|
||
<summary>
|
||
Content of the passage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingPassage.Id">
|
||
<summary>
|
||
Identifier for the passage for attributing this passage in grounded answers.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingPassageId">
|
||
<summary>
|
||
Identifier for a part within a <c>GroundingPassage</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingPassageId.PartIndex">
|
||
<summary>
|
||
Output only. Index of the part within the <c>GenerateAnswerRequest</c>'s <c>GroundingPassage.content</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingPassageId.PassageId">
|
||
<summary>
|
||
Output only. ID of the passage matching the <c>GenerateAnswerRequest</c>'s <c>GroundingPassage.id</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingPassages">
|
||
<summary>
|
||
A repeated list of passages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingPassages.Passages">
|
||
<summary>
|
||
List of passages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.GroundingSupport">
|
||
<summary>
|
||
A collection of supporting references for a segment of the model's response.
|
||
</summary>
|
||
<summary>
|
||
Grounding support.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingSupport.ConfidenceScores">
|
||
<summary>
|
||
Optional. Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingSupport.GroundingChunkIndices">
|
||
<summary>
|
||
Optional. A list of indices (into 'grounding_chunk' in <c>response.candidate.grounding_metadata</c>) specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. If the response is streaming, the grounding_chunk_indices refer to the indices across all responses. It is the client's responsibility to accumulate the grounding chunks from all responses (while maintaining the same order).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.GroundingSupport.Segment">
|
||
<summary>
|
||
Segment of the content this support belongs to.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockMethod.HarmBlockMethodUnspecified">
|
||
<summary>
|
||
The harm block method is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockMethod.Severity">
|
||
<summary>
|
||
The harm block method uses both probability and severity scores.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockMethod.Probability">
|
||
<summary>
|
||
The harm block method uses the probability score.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockThreshold.HarmBlockThresholdUnspecified">
|
||
<summary>
|
||
Threshold is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockThreshold.BlockLowAndAbove">
|
||
<summary>
|
||
Content with NEGLIGIBLE will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockThreshold.BlockMediumAndAbove">
|
||
<summary>
|
||
Content with NEGLIGIBLE and LOW will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockThreshold.BlockOnlyHigh">
|
||
<summary>
|
||
Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockThreshold.BlockNone">
|
||
<summary>
|
||
All content will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmBlockThreshold.Off">
|
||
<summary>
|
||
Turn off the safety filter.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryUnspecified">
|
||
<summary>
|
||
Category is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryDerogatory">
|
||
<summary>
|
||
**PaLM** - Negative or harmful comments targeting identity and/or protected attribute.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryToxicity">
|
||
<summary>
|
||
**PaLM** - Content that is rude, disrespectful, or profane.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryViolence">
|
||
<summary>
|
||
**PaLM** - Describes scenarios depicting violence against an individual or group, or general descriptions of gore.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategorySexual">
|
||
<summary>
|
||
**PaLM** - Contains references to sexual acts or other lewd content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryMedical">
|
||
<summary>
|
||
**PaLM** - Promotes unchecked medical advice.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryDangerous">
|
||
<summary>
|
||
**PaLM** - Dangerous content that promotes, facilitates, or encourages harmful acts.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryHarassment">
|
||
<summary>
|
||
**Gemini** - Harassment content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryHateSpeech">
|
||
<summary>
|
||
**Gemini** - Hate speech and content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategorySexuallyExplicit">
|
||
<summary>
|
||
**Gemini** - Sexually explicit content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryDangerousContent">
|
||
<summary>
|
||
**Gemini** - Dangerous content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmCategory.HarmCategoryCivicIntegrity">
|
||
<summary>
|
||
**Gemini** - Content that may be used to harm civic integrity. DEPRECATED: use enable_enhanced_civic_answers instead.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmProbability.HarmProbabilityUnspecified">
|
||
<summary>
|
||
Probability is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmProbability.Negligible">
|
||
<summary>
|
||
Content has a negligible chance of being unsafe.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmProbability.Low">
|
||
<summary>
|
||
Content has a low chance of being unsafe.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmProbability.Medium">
|
||
<summary>
|
||
Content has a medium chance of being unsafe.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmProbability.High">
|
||
<summary>
|
||
Content has a high chance of being unsafe.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmSeverity.HarmSeverityUnspecified">
|
||
<summary>
|
||
The harm severity is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmSeverity.HarmSeverityNegligible">
|
||
<summary>
|
||
The harm severity is negligible.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmSeverity.HarmSeverityLow">
|
||
<summary>
|
||
The harm severity is low.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmSeverity.HarmSeverityMedium">
|
||
<summary>
|
||
The harm severity is medium.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HarmSeverity.HarmSeverityHigh">
|
||
<summary>
|
||
The harm severity is high.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.HttpBody">
|
||
<summary>
|
||
Message that represents an arbitrary HTTP body.
|
||
It should only be used for payload formats that can't be represented as JSON,
|
||
such as raw binary or an HTML page.
|
||
This message can be used both in streaming and non-streaming API methods in the
|
||
request as well as the response. It can be used as a top-level request field,
|
||
which is convenient if one wants to extract parameters from either the URL or
|
||
HTTP template into the request fields and also want access to the raw HTTP body.
|
||
Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); }
|
||
Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.HttpBody.ContentType">
|
||
<summary>
|
||
The HTTP Content-Type header value specifying the content type of the body.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.HttpBody.Data">
|
||
<summary>
|
||
The HTTP request/response body as raw binary.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.HttpBody.Extensions">
|
||
<summary>
|
||
Application specific response metadata. Must be set in the first response for streaming APIs.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HttpElementLocation.HttpInQuery">
|
||
<summary>
|
||
Element is in the HTTP request query.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HttpElementLocation.HttpInHeader">
|
||
<summary>
|
||
Element is in the HTTP request header.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HttpElementLocation.HttpInPath">
|
||
<summary>
|
||
Element is in the HTTP request path.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HttpElementLocation.HttpInBody">
|
||
<summary>
|
||
Element is in the HTTP request body.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.HttpElementLocation.HttpInCookie">
|
||
<summary>
|
||
Element is in the HTTP request cookie.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.HttpOptions">
|
||
<summary>
|
||
HTTP options to be used in each of the requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.HttpOptions.ApiVersion">
|
||
<summary>
|
||
Specifies the version of the API to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.HttpOptions.BaseUrl">
|
||
<summary>
|
||
The base URL for the AI platform service endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.HttpOptions.Headers">
|
||
<summary>
|
||
Additional HTTP headers to be sent with the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.HttpOptions.Timeout">
|
||
<summary>
|
||
Timeout for the request in milliseconds.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Hyperparameters">
|
||
<summary>
|
||
Hyperparameters controlling the tuning process.
|
||
Read more at https://ai.google.dev/docs/model_tuning_guidance
|
||
</summary>
|
||
<summary>
|
||
Hyperparameters controlling the tuning process. Read more at https://ai.google.dev/docs/model_tuning_guidance
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Hyperparameters.AdapterSize">
|
||
<summary>
|
||
Optional: The Adapter size to use for the tuning job.
|
||
</summary>
|
||
<remarks>
|
||
The adapter size influences the number of trainable parameters for the tuning job.
|
||
A larger adapter size implies that the model can learn more complex tasks,
|
||
but it requires a larger training dataset and longer training times.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Hyperparameters.BatchSize">
|
||
<summary>
|
||
Immutable. The batch size hyperparameter for tuning. If not set, a default of 4 or 16 will be used based on the number of training examples.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Hyperparameters.EpochCount">
|
||
<summary>
|
||
Immutable. The number of training epochs. An epoch is one pass through the training data. If not set, a default of 5 will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Hyperparameters.LearningRate">
|
||
<summary>
|
||
Optional. Immutable. The learning rate hyperparameter for tuning. If not set, a default of 0.001 or 0.0002 will be calculated based on the number of training examples.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Hyperparameters.LearningRateMultiplier">
|
||
<summary>
|
||
Optional. Immutable. The learning rate multiplier is used to calculate a final learning_rate based on the default (recommended) value. Actual learning rate := learning_rate_multiplier * default learning rate Default learning rate is dependent on base model and dataset size. If not set, a default of 1.0 will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Image">
|
||
<summary>
|
||
An image generated by the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Image.BytesBase64Encoded">
|
||
<summary>
|
||
A base64 encoded string of one (generated) image. (20 MB)
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Image.MimeType">
|
||
<summary>
|
||
The IANA standard MIME type of the image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Image.GcsUri">
|
||
<summary>
|
||
Exists if storageUri is provided. The Cloud Storage uri where the generated images are stored.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Image.ImageBytes">
|
||
<summary>
|
||
The image bytes data.
|
||
<see cref="T:Mscc.GenerativeAI.Types.Image"/> can contain a value for this field or the `GcsUri` field but not both.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Image.B64Json">
|
||
<summary>
|
||
The base64-encoded JSON of the generated image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Image.Url">
|
||
<summary>
|
||
The URL of the generated image, if response_format is url (default).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Image.RevisedPrompt">
|
||
<summary>
|
||
The prompt that was used to generate the image, if there was any revision to the prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageConfig">
|
||
<summary>
|
||
Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.
|
||
</summary>
|
||
<summary>
|
||
Config for image generation features.
|
||
</summary>
|
||
<summary>
|
||
Config for image generation features.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfig.ImageOutputOptions">
|
||
<summary>
|
||
Optional. The image output format for generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfig.PersonGeneration">
|
||
<summary>
|
||
Optional. Controls whether the model can generate people.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageConfig.PersonGenerationType.PersonGenerationUnspecified">
|
||
<summary>
|
||
The default behavior is unspecified. The model will decide whether to generate images of people.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageConfig.PersonGenerationType.AllowAll">
|
||
<summary>
|
||
Allows the model to generate images of people, including adults and children.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageConfig.PersonGenerationType.AllowAdult">
|
||
<summary>
|
||
Allows the model to generate images of adults, but not children.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageConfig.PersonGenerationType.AllowNone">
|
||
<summary>
|
||
Prevents the model from generating images of people.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfig.AspectRatio">
|
||
<summary>
|
||
Optional. The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfig.ImageSize">
|
||
<summary>
|
||
Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If
|
||
not specified, the model will use default value `1K`
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfig.OutputMimeType">
|
||
<summary>
|
||
MIME type of the generated image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfig.OutputCompressionQuality">
|
||
<summary>
|
||
Compression quality of the generated image (for ``image/jpeg`` only).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageConfigImageOutputOptions">
|
||
<summary>
|
||
The image output format for generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfigImageOutputOptions.CompressionQuality">
|
||
<summary>
|
||
Optional. The compression quality of the output image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageConfigImageOutputOptions.MimeType">
|
||
<summary>
|
||
Optional. The image format that the output should be saved as.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageGenerationParameters">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.SampleCount">
|
||
<summary>
|
||
The number of generated images.
|
||
</summary>
|
||
<remarks>Accepted integer values: 1-8 (v.002), 1-4 (v.005, v.006). Default value: 4.</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.NumberOfImages">
|
||
<summary>
|
||
The number of generated images.
|
||
</summary>
|
||
<remarks>Accepted integer values: 1-8 (v.002), 1-4 (v.005, v.006). Default value: 4.</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.StorageUri">
|
||
<summary>
|
||
Optional. Cloud Storage URI for where to store the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.Seed">
|
||
<summary>
|
||
Optional. Pseudo random seed for reproducible generated outcome;
|
||
setting the seed lets you generate deterministic output.
|
||
</summary>
|
||
<remarks>
|
||
Version 006 model only: To use the seed field you must also set "addWatermark": false in the list of parameters.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.Language">
|
||
<summary>
|
||
Optional. The text prompt for guiding the response.
|
||
</summary>
|
||
<remarks>en (default), de, fr, it, es</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.NegativePrompt">
|
||
<summary>
|
||
Optional. Description of what to discourage in the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.GuidanceScale">
|
||
<summary>
|
||
Optional. For model version 006 and greater use editConfig.guidanceScale.
|
||
</summary>
|
||
<remarks>
|
||
Controls how much the model adheres to the text prompt.
|
||
Large values increase output and prompt alignment, but may compromise image quality.
|
||
Values: 0-500 - Default: 60
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.DisablePersonFace">
|
||
<summary>
|
||
Optional. Whether to disable the person/face safety filter (so that person/face can be included in the generated images).
|
||
</summary>
|
||
<remarks>Deprecated (v.006 only): Use personGeneration instead.</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.Mode">
|
||
<summary>
|
||
Optional. With input prompt, image, mask - backgroundEditing mode enables background editing.
|
||
</summary>
|
||
<remarks>Values:
|
||
backgroundEditing
|
||
upscale
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.SampleImageSize">
|
||
<summary>
|
||
Optional. Sample image size when mode is set to upscale. This field is no longer required when upscaling. Use upscaleConfig.upscaleFactor to set the upscaled image size.
|
||
</summary>
|
||
<remarks>2048 or 4096</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.AspectRatio">
|
||
<summary>
|
||
Optional. The aspect ratio of the generated image.
|
||
</summary>
|
||
<remarks>Value: 1:1, 9:16*, 16:9*, 3:4*, or 4:3*</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.IncludeSafetyAttributes">
|
||
<summary>
|
||
Optional. Whether to enable rounded Responsible AI scores for a list of safety attributes in responses for unfiltered input and output.
|
||
</summary>
|
||
<remarks>Safety attribute categories: "Death, Harm and Tragedy", "Firearms and Weapons", "Hate", "Health", "Illicit Drugs", "Politics", "Porn", "Religion and Belief", "Toxic", "Violence", "Vulgarity", "War and Conflict".</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.PersonGeneration">
|
||
<summary>
|
||
Optional. The safety setting that controls the type of people or face generation allowed.
|
||
</summary>
|
||
<remarks>"personGeneration": "allow_all" is not available in Imagen 2 Editing and is only available to approved users‡ in Imagen 2 Generation.
|
||
Values:
|
||
allow_all: Allow generation of people of all ages.
|
||
allow_adult (default): Allow generation of adults only.
|
||
dont_allow: Disables the inclusion of people or faces in images.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.SafetyFilterLevel">
|
||
<summary>
|
||
Optional. The safety setting that controls safety filter thresholds.
|
||
</summary>
|
||
<remarks>Values:
|
||
block_most: The highest threshold resulting in most requests blocked.
|
||
block_some (default): The medium threshold that balances blocks for potentially harmful and benign content.
|
||
block_few: Reduces the number of requests blocked due to safety filters. This setting might increase objectionable content generated by Imagen.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.AddWatermark">
|
||
<summary>
|
||
Defines whether the image will include a SynthID. For more information, see Identifying AI-generated content with SynthID.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.EditConfig">
|
||
<summary>
|
||
edit config object for model versions 006 and greater. All editConfig subfields are optional. If not specified, the default editing mode is inpainting.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.UpscaleConfig">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.OutputOptions">
|
||
<summary>
|
||
Optional. Describes the output image format in an <see cref="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.OutputOptions"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.EnhancePrompt">
|
||
<summary>
|
||
Whether to use the prompt rewriting logic.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.OutputGcsUri">
|
||
<summary>
|
||
Cloud Storage URI used to store the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.OutputMimeType">
|
||
<summary>
|
||
MIME type of the generated image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.OutputCompressionQuality">
|
||
<summary>
|
||
Compression quality of the generated image (for `image/jpeg` only).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationParameters.Labels">
|
||
<summary>
|
||
User specified labels to track billing usage.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageGenerationRequest">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationRequest.Instances">
|
||
<summary>
|
||
An array that contains the object with image details to get information about.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationRequest.Parameters">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ImageGenerationRequest.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.ImageGenerationRequest"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ImageGenerationRequest.#ctor(System.String,System.Nullable{System.Int32})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.ImageGenerationRequest"/> class.
|
||
</summary>
|
||
<param name="prompt">The text prompt guides what images the model generates.</param>
|
||
<param name="sampleCount">The number of generated images.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="prompt"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="sampleCount"/> is less than 1 or greater than 8.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageGenerationResponse">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageGenerationResponse.Predictions">
|
||
<summary>
|
||
Output only. A list of the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageOutputOptions.CompressionQuality">
|
||
<summary>
|
||
Optional. The compression quality of the output image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageOutputOptions.MimeType">
|
||
<summary>
|
||
Optional. The image format that the output should be saved as.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImagePromptLanguage">
|
||
<summary>
|
||
A list of languages (lower case?!)
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageQuality">
|
||
<summary>
|
||
The quality of the image that will be generated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageQuality.Standard">
|
||
<summary>
|
||
Standard quality.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageQuality.Hd">
|
||
<summary>
|
||
High definition quality.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageReferenceType">
|
||
<summary>
|
||
The type of the reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageReferenceType.ReferenceTypeRaw">
|
||
<summary>
|
||
Raw reference type
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageReferenceType.ReferenceTypeMask">
|
||
<summary>
|
||
Mask reference type
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageReferenceType.ReferenceTypeControl">
|
||
<summary>
|
||
Control reference type
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageReferenceType.ReferenceTypeSubject">
|
||
<summary>
|
||
Subject reference type
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageReferenceType.ReferenceTypeStyle">
|
||
<summary>
|
||
Style reference type
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageSearch">
|
||
<summary>
|
||
Image search for grounding and related configurations.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImagesGenerationsRequest">
|
||
<summary>
|
||
OpenAI image generation request
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.Prompt">
|
||
<summary>
|
||
A text description of the desired image(s).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.Model">
|
||
<summary>
|
||
Required. The name of the `Model` to use for generating the completion.
|
||
The model name will prefixed by \"models/\" if no slash appears in it.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.N">
|
||
<summary>
|
||
Optional. Amount of candidate completions to generate.
|
||
Must be a positive integer. Defaults to 1 if not set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.Quality">
|
||
<summary>
|
||
The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.ResponseFormat">
|
||
<summary>
|
||
Optional. The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.Size">
|
||
<summary>
|
||
The size of the generated images.
|
||
</summary>
|
||
<remarks>
|
||
Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.Style">
|
||
<summary>
|
||
The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsRequest.User">
|
||
<summary>
|
||
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImagesGenerationsResponse">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsResponse.Model">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsResponse.Data">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImagesGenerationsResponse.Created">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageStyle">
|
||
<summary>
|
||
The style of the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageStyle.Vivid">
|
||
<summary>
|
||
Vivid causes the model to lean towards generating hyper-real and dramatic images.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ImageStyle.Natural">
|
||
<summary>
|
||
Natural causes the model to produce more natural, less hyper-real looking images.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageTextParameters">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextParameters.SampleCount">
|
||
<summary>
|
||
The number of generated images.
|
||
</summary>
|
||
<remarks>Accepted integer values: 1-3</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextParameters.StorageUri">
|
||
<summary>
|
||
Optional. Cloud Storage uri where to store the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextParameters.Seed">
|
||
<summary>
|
||
Optional. The seed for random number generator (RNG). If RNG seed is the same for requests with the inputs, the prediction results will be the same.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextParameters.Language">
|
||
<summary>
|
||
Optional. The text prompt for guiding the response.
|
||
</summary>
|
||
<remarks>en (default), de, fr, it, es</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageTextRequest">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextRequest.Instances">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextRequest.Parameters">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ImageTextRequest.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.ImageGenerationRequest"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.ImageTextRequest.#ctor(System.String,System.String,System.Nullable{System.Int32},System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.ImageGenerationRequest"/> class.
|
||
</summary>
|
||
<param name="base64Image">The base64 encoded image to process.</param>
|
||
<param name="question">The question to ask about the image.</param>
|
||
<param name="sampleCount">The number of predictions.</param>
|
||
<param name="language">Language of predicted text. Defaults to "en".</param>
|
||
<param name="storageUri">Optional. Cloud Storage URI where to store the generated predictions.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="base64Image"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="sampleCount"/> is less than 1 or greater than 3.</exception>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="language"/> is not supported.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImageTextResponse">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextResponse.Predictions">
|
||
<summary>
|
||
List of text strings representing captions, sorted by confidence.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextResponse.DeployedModelId">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextResponse.Model">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextResponse.ModelDisplayName">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImageTextResponse.ModelVersionId">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ImportFileRequest">
|
||
<summary>
|
||
Request for <c>ImportFile</c> to import a File API file with a <c>FileSearchStore</c>. LINT.IfChange(ImportFileRequest)
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImportFileRequest.ChunkingConfig">
|
||
<summary>
|
||
Optional. Config for telling the service how to chunk the file. If not provided, the service will use default parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImportFileRequest.CustomMetadata">
|
||
<summary>
|
||
Custom metadata to be associated with the file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ImportFileRequest.FileName">
|
||
<summary>
|
||
Required. The name of the <c>File</c> to import. Example: <c>files/abc-123</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlineData">
|
||
<summary>
|
||
Raw media bytes sent directly in the request.
|
||
Text should not be sent as raw bytes.
|
||
</summary>
|
||
<remarks>
|
||
Serialized bytes data of the image or video.
|
||
You can specify at most 1 image with inlineData. To specify up to 16 images, use fileData.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlineData.Data">
|
||
<summary>
|
||
The base64 encoding of the image, PDF, or video to include inline in the prompt.
|
||
</summary>
|
||
<remarks>
|
||
When including media inline, you must also specify MIMETYPE.
|
||
Size limit: 20MB
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlineData.MimeType">
|
||
<summary>
|
||
The IANA standard MIME type of the source data.
|
||
</summary>
|
||
<remarks>
|
||
The media type of the image, PDF, or video specified in the data or fileUri fields.
|
||
Acceptable values include the following:
|
||
"image/png", "image/jpeg", "image/heic", "image/heif", "image/webp".
|
||
application/pdf
|
||
video/mov
|
||
video/mpeg
|
||
video/mp4
|
||
video/mpg
|
||
video/avi
|
||
video/wmv
|
||
video/mpegps
|
||
video/flv
|
||
Maximum video length: 2 minutes. No limit on image resolution.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlineData.DisplayName">
|
||
<summary>
|
||
Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in <c>PromptMessage</c> for prompt management. It is used in the Gemini calls only when server side tools (<c>code_execution</c>, <c>google_search</c>, and <c>url_context</c>) are enabled.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedEmbedContentRequest">
|
||
<summary>
|
||
The request to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedEmbedContentRequest.Metadata">
|
||
<summary>
|
||
Optional. The metadata to be associated with the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedEmbedContentRequest.Request">
|
||
<summary>
|
||
Required. The request to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedEmbedContentRequests">
|
||
<summary>
|
||
The requests to be processed in the batch if provided as part of the batch creation request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedEmbedContentRequests.Requests">
|
||
<summary>
|
||
Required. The requests to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedEmbedContentResponse">
|
||
<summary>
|
||
The response to a single request in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedEmbedContentResponse.Error">
|
||
<summary>
|
||
Output only. The error encountered while processing the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedEmbedContentResponse.Metadata">
|
||
<summary>
|
||
Output only. The metadata associated with the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedEmbedContentResponse.Response">
|
||
<summary>
|
||
Output only. The response to the request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedEmbedContentResponses">
|
||
<summary>
|
||
The responses to the requests in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedEmbedContentResponses.InlinedResponses">
|
||
<summary>
|
||
Output only. The responses to the requests in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedRequest">
|
||
<summary>
|
||
The request to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedRequest.Metadata">
|
||
<summary>
|
||
Optional. The metadata to be associated with the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedRequest.Request">
|
||
<summary>
|
||
Required. The request to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedRequests">
|
||
<summary>
|
||
The requests to be processed in the batch if provided as part of the batch creation request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedRequests.Requests">
|
||
<summary>
|
||
Required. The requests to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedResponse">
|
||
<summary>
|
||
The response to a single request in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedResponse.Error">
|
||
<summary>
|
||
Output only. The error encountered while processing the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedResponse.Metadata">
|
||
<summary>
|
||
Output only. The metadata associated with the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedResponse.Response">
|
||
<summary>
|
||
Output only. The response to the request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InlinedResponses">
|
||
<summary>
|
||
The responses to the requests in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InlinedResponses.Responses">
|
||
<summary>
|
||
Output only. The responses to the requests in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InputConfig">
|
||
<summary>
|
||
Configures the input to the batch request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InputConfig.FileName">
|
||
<summary>
|
||
The name of the <c>File</c> containing the input requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InputConfig.Requests">
|
||
<summary>
|
||
The requests to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InputEmbedContentConfig">
|
||
<summary>
|
||
Configures the input to the batch request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InputEmbedContentConfig.FileName">
|
||
<summary>
|
||
The name of the <c>File</c> containing the input requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InputEmbedContentConfig.Requests">
|
||
<summary>
|
||
The requests to be processed in the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.InputFeedback">
|
||
<summary>
|
||
Feedback related to the input data used to answer the question, as opposed to the model-generated response to the question.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InputFeedback.BlockReason">
|
||
<summary>
|
||
Optional. If set, the input was blocked and no candidates are returned. Rephrase the input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InputFeedback.SafetyRatings">
|
||
<summary>
|
||
Ratings for safety of the input. There is at most one rating per category.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Instance">
|
||
<summary>
|
||
An instance of an image with additional metadata.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Instance.Prompt">
|
||
<summary>
|
||
Required. The text prompt for the image.
|
||
</summary>
|
||
<remarks>
|
||
The text prompt guides what images the model generates. This field is required for both generation and editing.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Instance.Image">
|
||
<summary>
|
||
Optional. Input image for editing.
|
||
</summary>
|
||
<remarks>Base64 encoded image (20 MB)</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Instance.Mask">
|
||
<summary>
|
||
Optional. Mask image for mask-based editing.
|
||
</summary>
|
||
<remarks>Base64 input image with 1s and 0s where 1 indicates regions to keep (PNG) (20 MB)</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Instance.ReferenceImages">
|
||
<summary>
|
||
Optional. A list of reference images for the editing operation.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.IntegratedGradientsAttribution">
|
||
<summary>
|
||
An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IntegratedGradientsAttribution.BlurBaselineConfig">
|
||
<summary>
|
||
Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IntegratedGradientsAttribution.SmoothGradConfig">
|
||
<summary>
|
||
Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IntegratedGradientsAttribution.StepCount">
|
||
<summary>
|
||
Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.InteractionResource.Text">
|
||
<summary>
|
||
A convenience property to get the responded text information of first candidate.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Interval">
|
||
<summary>
|
||
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Interval.EndTime">
|
||
<summary>
|
||
Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Interval.StartTime">
|
||
<summary>
|
||
Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.JiraSource">
|
||
<summary>
|
||
The Jira source for the ImportRagFilesRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.JiraSource.JiraQueries">
|
||
<summary>
|
||
Required. The Jira queries.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.JiraSourceJiraQueries">
|
||
<summary>
|
||
JiraQueries contains the Jira queries and corresponding authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.JiraSourceJiraQueries.ApiKeyConfig">
|
||
<summary>
|
||
Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key. See [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.JiraSourceJiraQueries.CustomQueries">
|
||
<summary>
|
||
A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.JiraSourceJiraQueries.Email">
|
||
<summary>
|
||
Required. The Jira email address.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.JiraSourceJiraQueries.Projects">
|
||
<summary>
|
||
A list of Jira projects to import in their entirety.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.JiraSourceJiraQueries.ServerUri">
|
||
<summary>
|
||
Required. The Jira server URI.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Language.LanguageUnspecified">
|
||
<summary>
|
||
Unspecified language. This value should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Language.Python">
|
||
<summary>
|
||
Python >= 3.10, with numpy and simpy available. Python is the default language.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.LatLng">
|
||
<summary>
|
||
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LatLng.Latitude">
|
||
<summary>
|
||
The latitude in degrees. It must be in the range [-90.0, +90.0].
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LatLng.Longitude">
|
||
<summary>
|
||
The longitude in degrees. It must be in the range [-180.0, +180.0].
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListBatchJobsConfig">
|
||
<summary>
|
||
Config for optional parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListBatchJobsConfig.Filter">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListBatchJobsConfig.PageSize">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListBatchJobsConfig.PageToken">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListCachedContentsResponse">
|
||
<summary>
|
||
Response with a list of CachedContents.
|
||
</summary>
|
||
<summary>
|
||
Response with CachedContents list.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListCachedContentsResponse.CachedContents">
|
||
<summary>
|
||
List of cached contents.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListCachedContentsResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <c>page_token</c> to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListChunksResponse">
|
||
<summary>
|
||
Response from <see cref="!:ListChunks"/> containing a paginated list of <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s. The <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s are sorted by ascending <see cref="!:chunk.create_time"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListChunksResponse.Chunks">
|
||
<summary>
|
||
The returned <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListChunksResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <see cref="!:page_token"/> to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListContextsResponse">
|
||
<summary>
|
||
Response message for MetadataService.ListContexts.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListContextsResponse.Contexts">
|
||
<summary>
|
||
The Contexts retrieved from the MetadataStore.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListContextsResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as ListContextsRequest.page_token to retrieve the next page. If this field is not populated, there are no subsequent pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListCorporaResponse">
|
||
<summary>
|
||
Response from <c>ListCorpora</c> containing a paginated list of <c>Corpora</c>. The results are sorted by ascending <c>corpus.create_time</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListCorporaResponse.Corpora">
|
||
<summary>
|
||
The returned corpora.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListCorporaResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <c>page_token</c> to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListDocumentsResponse">
|
||
<summary>
|
||
Response from <c>ListDocuments</c> containing a paginated list of <c>Document</c>s. The <c>Document</c>s are sorted by ascending <c>document.create_time</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListDocumentsResponse.Documents">
|
||
<summary>
|
||
The returned <c>Document</c>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListDocumentsResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <c>page_token</c> to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListFileSearchStoresResponse">
|
||
<summary>
|
||
Response from <c>ListFileSearchStores</c> containing a paginated list of <c>FileSearchStores</c>. The results are sorted by ascending <c>file_search_store.create_time</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListFileSearchStoresResponse.FileSearchStores">
|
||
<summary>
|
||
The returned rag_stores.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListFileSearchStoresResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <c>page_token</c> to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListFilesResponse">
|
||
<summary>
|
||
Response for <c>ListFiles</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListFilesResponse.Files">
|
||
<summary>
|
||
The list of <c>File</c>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListFilesResponse.NextPageToken">
|
||
<summary>
|
||
A token that can be sent as a <c>page_token</c> into a subsequent <c>ListFiles</c> call.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListGeneratedFilesResponse">
|
||
<summary>
|
||
Response for <c>ListGeneratedFiles</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListGeneratedFilesResponse.GeneratedFiles">
|
||
<summary>
|
||
The list of <c>GeneratedFile</c>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListGeneratedFilesResponse.NextPageToken">
|
||
<summary>
|
||
A token that can be sent as a <c>page_token</c> into a subsequent <c>ListGeneratedFiles</c> call.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListModelsConfig">
|
||
<summary>
|
||
Configuration for retrieving models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListModelsConfig.QueryBase">
|
||
<summary>
|
||
If query_base is set to True in the config or not set (default), the API will return all available base models. If set to False, it will return all tuned models.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListModelsResponse">
|
||
<summary>
|
||
Response message for ModelService.ListModels
|
||
</summary>
|
||
<summary>
|
||
Response from <c>ListModel</c> containing a paginated list of Models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListModelsResponse.Models">
|
||
<summary>
|
||
The returned Models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListModelsResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <c>page_token</c> to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListOperationsResponse">
|
||
<summary>
|
||
The response message for Operations.ListOperations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListOperationsResponse.NextPageToken">
|
||
<summary>
|
||
The standard List next-page token.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListOperationsResponse.Operations">
|
||
<summary>
|
||
A list of operations that matches the specified filter in the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListOperationsResponse.Unreachable">
|
||
<summary>
|
||
Unordered list. Unreachable resources. Populated when the request sets <c>ListOperationsRequest.return_partial_success</c> and reads across collections. For example, when attempting to list all resources across all supported locations.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListPermissionsResponse">
|
||
<summary>
|
||
Response from <c>ListPermissions</c> containing a paginated list of permissions.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListPermissionsResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <c>page_token</c> to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListPermissionsResponse.Permissions">
|
||
<summary>
|
||
Returned permissions.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListRagCorporaResponse">
|
||
<summary>
|
||
Response message for VertexRagDataService.ListRagCorpora.
|
||
</summary>
|
||
<summary>
|
||
Response from `ListRagEngineCorpora` containing a paginated list of `RagEngineCorpora`.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagCorporaResponse.NextPageToken">
|
||
<summary>
|
||
A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagCorporaResponse.RagCorpora">
|
||
<summary>
|
||
List of RagCorpora in the requested page.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagCorporaResponse.Corpora">
|
||
<summary>
|
||
The returned corpora.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListRagFilesResponse">
|
||
<summary>
|
||
Response message for VertexRagDataService.ListRagFiles.
|
||
</summary>
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagFilesResponse.NextPageToken">
|
||
<summary>
|
||
A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagFilesResponse.RagFiles">
|
||
<summary>
|
||
List of RagFiles in the requested page.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagFilesResponse.Files">
|
||
<summary>
|
||
The list of files.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListTunedModelsResponse">
|
||
<summary>
|
||
Response from <c>ListTunedModels</c> containing a paginated list of Models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListTunedModelsResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as <c>page_token</c> to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListTunedModelsResponse.TunedModels">
|
||
<summary>
|
||
The returned Models.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.LiveConnectConfig">
|
||
<summary>
|
||
Session config for the API connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LiveConnectConfig.GenerationConfig">
|
||
<summary>
|
||
The generation configuration for the session.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LiveConnectConfig.ResponseModalities">
|
||
<summary>
|
||
The requested modalities of the response. Represents the set of modalities that the model can return.
|
||
Defaults to AUDIO if not specified.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LiveConnectConfig.SpeechConfig">
|
||
<summary>
|
||
The speech generation configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LiveConnectConfig.SystemInstruction">
|
||
<summary>
|
||
The user provided system instructions for the model.
|
||
Note: only text should be used in parts and content in each part will be in a separate paragraph.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LiveConnectConfig.Tools">
|
||
<summary>
|
||
A list of `Tools` the model may use to generate the next response.
|
||
</summary>
|
||
<remarks>
|
||
A `Tool` is a piece of code that enables the system to interact with external systems to perform an action,
|
||
or set of actions, outside of knowledge and scope of the model.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.LLMBasedMetricSpec">
|
||
<summary>
|
||
Specification for an LLM based metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LLMBasedMetricSpec.AdditionalConfig">
|
||
<summary>
|
||
Optional. Optional additional configuration for the metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LLMBasedMetricSpec.JudgeAutoraterConfig">
|
||
<summary>
|
||
Optional. Optional configuration for the judge LLM (Autorater).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LLMBasedMetricSpec.MetricPromptTemplate">
|
||
<summary>
|
||
Required. Template for the prompt sent to the judge model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LLMBasedMetricSpec.PredefinedRubricGenerationSpec">
|
||
<summary>
|
||
Dynamically generate rubrics using a predefined spec.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LLMBasedMetricSpec.RubricGenerationSpec">
|
||
<summary>
|
||
Dynamically generate rubrics using this specification.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LLMBasedMetricSpec.RubricGroupKey">
|
||
<summary>
|
||
Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LLMBasedMetricSpec.SystemInstruction">
|
||
<summary>
|
||
Optional. System instructions for the judge model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.LogprobsResult">
|
||
<summary>
|
||
The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information.
|
||
</summary>
|
||
<summary>
|
||
Logprobs Result
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LogprobsResult.ChosenCandidates">
|
||
<summary>
|
||
Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LogprobsResult.LogProbabilitySum">
|
||
<summary>
|
||
Sum of log probabilities for all tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LogprobsResult.TopCandidates">
|
||
<summary>
|
||
Length = total number of decoding steps.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.LogprobsResultCandidate">
|
||
<summary>
|
||
A single token and its associated log probability.
|
||
</summary>
|
||
<summary>
|
||
Candidate for the logprobs token and score.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LogprobsResultCandidate.LogProbability">
|
||
<summary>
|
||
The candidate's log probability.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LogprobsResultCandidate.Token">
|
||
<summary>
|
||
The candidate’s token string value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LogprobsResultCandidate.TokenId">
|
||
<summary>
|
||
The candidate’s token id value.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.LogprobsResultTopCandidates">
|
||
<summary>
|
||
A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.LogprobsResultTopCandidates.Candidates">
|
||
<summary>
|
||
The list of candidate tokens, sorted by log probability in descending order.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ManualRoutingMode">
|
||
<summary>
|
||
The configuration for manual routing. When manual routing is specified, the model will be
|
||
/// selected based on the model name provided. This data type is not supported in Gemini API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ManualRoutingMode.ModelName">
|
||
<summary>
|
||
The name of the model to use. Only public LLM models are accepted.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Maps">
|
||
<summary>
|
||
A grounding chunk from Google Maps. A Maps chunk corresponds to a single place.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Maps.PlaceAnswerSources">
|
||
<summary>
|
||
Sources that provide answers about the features of a given place in Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Maps.PlaceId">
|
||
<summary>
|
||
The ID of the place, in <c>places/{place_id}</c> format. A user can use this ID to look up that place.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Maps.Text">
|
||
<summary>
|
||
Text description of the place answer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Maps.Title">
|
||
<summary>
|
||
Title of the place.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Maps.Uri">
|
||
<summary>
|
||
URI reference of the place.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Mask">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Mask.Image">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.MaskImageConfig">
|
||
<summary>
|
||
Configuration for a Mask reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MaskImageConfig.MaskMode">
|
||
<summary>
|
||
Prompts the model to generate a mask instead of you needing to provide
|
||
one (unless MASK_MODE_USER_PROVIDED is used).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MaskImageConfig.MaskClasses">
|
||
<summary>
|
||
A list of up to 5 class ids to use for semantic segmentation.
|
||
Automatically creates an image mask based on specific objects.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MaskImageConfig.Dilation">
|
||
<summary>
|
||
Dilation percentage of the mask provided.
|
||
</summary>
|
||
<remarks>
|
||
Float between 0 and 1.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.MaskMode">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MaskMode.MaskType">
|
||
<summary>
|
||
Optional. Prompts the model to generate a mask instead of you needing to provide one. Consequently, when you provide this parameter you can omit a mask object.
|
||
</summary>
|
||
<remarks>Values:
|
||
background: Automatically generates a mask to all regions except primary object, person, or subject in the image
|
||
foreground: Automatically generates a mask to the primary object, person, or subject in the image
|
||
semantic: Use automatic segmentation to create a mask area for one or more of the segmentation classes. Set the segmentation classes using the classes parameter and the corresponding class_id values. You can specify up to 5 classes.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MaskMode.Classes">
|
||
<summary>
|
||
Optional. Determines the classes of objects that will be segmented in an automatically generated mask image.
|
||
If you use this field, you must also set "maskType": "semantic".
|
||
See <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/image-generation#segment-ids">Segmentation class IDs</a>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.MaskReferenceMode">
|
||
<summary>
|
||
The mask mode of a reference image
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MaskReferenceMode.MaskModeDefault">
|
||
<summary>
|
||
Default mask mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MaskReferenceMode.MaskModeBackground">
|
||
<summary>
|
||
automatically generate a mask using background segmentation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MaskReferenceMode.MaskModeForeground">
|
||
<summary>
|
||
automatically generate a mask using foreground segmentation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MaskReferenceMode.MaskModeSemantic">
|
||
<summary>
|
||
automatically generate a mask using semantic segmentation, and the given mask class.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MaskReferenceMode.MaskModeUserProvided">
|
||
<summary>
|
||
the reference image is a mask image.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.McpServer">
|
||
<summary>
|
||
A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol. Next ID: 5
|
||
</summary>
|
||
<summary>
|
||
A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol. Next ID: 5
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.McpServer.Name">
|
||
<summary>
|
||
The name of the MCPServer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.McpServer.StreamableHttpTransport">
|
||
<summary>
|
||
A transport that can stream HTTP requests and responses.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Media">
|
||
<summary>
|
||
A reference to data stored on the filesystem, on GFS or in blobstore.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Filename">
|
||
<summary>
|
||
Original file name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Inline">
|
||
<summary>
|
||
Media data, set if reference_type is INLINE
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.CompositeMedia">
|
||
<summary>
|
||
A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA.
|
||
The media length field must be set to the sum of the lengths of all composite media objects.
|
||
Note: All composite media must have length specified.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.DownloadParameters">
|
||
<summary>
|
||
Parameters for a media download.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Token">
|
||
<summary>
|
||
A unique fingerprint/version id for the media data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.ContentTypeInfo">
|
||
<summary>
|
||
Extended content type information provided for Scotty uploads.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Sha1Hash">
|
||
<summary>
|
||
Scotty-provided SHA1 hash for an upload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Sha256Hash">
|
||
<summary>
|
||
Scotty-provided SHA256 hash for an upload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Md5Hash">
|
||
<summary>
|
||
Scotty-provided MD5 hash for an upload.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.HashVerified">
|
||
<summary>
|
||
For Scotty uploads only.
|
||
If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.ContentType">
|
||
<summary>
|
||
MIME type of the data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.DiffUploadRequest">
|
||
<summary>
|
||
Set if reference_type is DIFF_UPLOAD_REQUEST.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.DiffUploadResponse">
|
||
<summary>
|
||
Set if reference_type is DIFF_UPLOAD_RESPONSE.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.DiffChecksumsResponse">
|
||
<summary>
|
||
Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.DiffVersionResponse">
|
||
<summary>
|
||
Set if reference_type is DIFF_VERSION_RESPONSE.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.DiffDownloadResponse">
|
||
<summary>
|
||
Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Algorithm">
|
||
<summary>
|
||
Deprecated, use one of explicit hash type fields instead.
|
||
Algorithm used for calculating the hash.
|
||
As of 2011/01/21, \"MD5\" is the only possible value for this field.
|
||
New values may be added at any time.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.ReferenceType">
|
||
<summary>
|
||
Describes what the field reference contains.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.BigstoreObjectRef">
|
||
<summary>
|
||
Use object_id instead.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Timestamp">
|
||
<summary>
|
||
Time at which the media data was last updated, in milliseconds since UNIX epoch
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Path">
|
||
<summary>
|
||
Path to the data, set if reference_type is PATH
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Blobstore2Info">
|
||
<summary>
|
||
Blobstore v2 info, set if reference_type is BLOBSTORE_REF, and it refers to a v2 blob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Hash">
|
||
<summary>
|
||
Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: Hex encoded hash value of the uploaded media.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.BlobRef">
|
||
<summary>
|
||
Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Length">
|
||
<summary>
|
||
Size of the data, in bytes
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.ObjectId">
|
||
<summary>
|
||
Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.IsPotentialRetry">
|
||
<summary>
|
||
|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.Crc32CHash">
|
||
<summary>
|
||
For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.MediaId">
|
||
<summary>
|
||
Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Media.CosmoBinaryReference">
|
||
<summary>
|
||
A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.MediaResolution">
|
||
<summary>
|
||
Media resolution for the input media.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MediaResolution.LevelType.MediaResolutionUnspecified">
|
||
<summary>
|
||
Media resolution has not been set.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MediaResolution.LevelType.MediaResolutionLow">
|
||
<summary>
|
||
Media resolution set to low.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MediaResolution.LevelType.MediaResolutionMedium">
|
||
<summary>
|
||
Media resolution set to medium.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MediaResolution.LevelType.MediaResolutionHigh">
|
||
<summary>
|
||
Media resolution set to high.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.MediaResolution.LevelType.MediaResolutionUltraHigh">
|
||
<summary>
|
||
Media resolution set to ultra high.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Message">
|
||
<summary>
|
||
The base unit of structured text. A <c>Message</c> includes an <c>author</c> and the <c>content</c> of the <c>Message</c>. The <c>author</c> is used to tag messages when they are fed to the model as text.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Message.Author">
|
||
<summary>
|
||
Optional. The author of this Message. This serves as a key for tagging the content of this Message when it is fed to the model as text. The author can be any alphanumeric string.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Message.CitationMetadata">
|
||
<summary>
|
||
Output only. Citation information for model-generated <c>content</c> in this <c>Message</c>. If this <c>Message</c> was generated as output from the model, this field may be populated with attribution information for any text included in the <c>content</c>. This field is used only on output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Message.Content">
|
||
<summary>
|
||
Required. The text content of the structured <c>Message</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.MessagePrompt">
|
||
<summary>
|
||
All of the structured input text passed to the model as a prompt. A <c>MessagePrompt</c> contains a structured set of fields that provide context for the conversation, examples of user input/model output message pairs that prime the model to respond in different ways, and the conversation history or list of messages representing the alternating turns of the conversation between the user and the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MessagePrompt.Context">
|
||
<summary>
|
||
Optional. Text that should be provided to the model first to ground the response. If not empty, this <c>context</c> will be given to the model first before the <c>examples</c> and <c>messages</c>. When using a <c>context</c> be sure to provide it with every request to maintain continuity. This field can be a description of your prompt to the model to help provide context and guide the responses. Examples: "Translate the phrase from English to French." or "Given a statement, classify the sentiment as happy, sad or neutral." Anything included in this field will take precedence over message history if the total input size exceeds the model's <c>input_token_limit</c> and the input request is truncated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MessagePrompt.Examples">
|
||
<summary>
|
||
Optional. Examples of what the model should generate. This includes both user input and the response that the model should emulate. These <c>examples</c> are treated identically to conversation messages except that they take precedence over the history in <c>messages</c>: If the total input size exceeds the model's <c>input_token_limit</c> the input will be truncated. Items will be dropped from <c>messages</c> before <c>examples</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MessagePrompt.Messages">
|
||
<summary>
|
||
Required. A snapshot of the recent conversation history sorted chronologically. Turns alternate between two authors. If the total input size exceeds the model's <c>input_token_limit</c> the input will be truncated: The oldest items will be dropped from <c>messages</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Metadata">
|
||
<summary>
|
||
Metadata for a chunk.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metadata.Attributes">
|
||
<summary>
|
||
Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.MetadataFilter">
|
||
<summary>
|
||
User provided filter to limit retrieval based on <c>Chunk</c> or <c>Document</c> level metadata values. Example (genre = drama OR genre = action): key = "document.custom_metadata.genre" conditions = [{string_value = "drama", operation = EQUAL}, {string_value = "action", operation = EQUAL}]
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MetadataFilter.Conditions">
|
||
<summary>
|
||
Required. The <c>Condition</c>s for the given key that will trigger this filter. Multiple <c>Condition</c>s are joined by logical ORs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MetadataFilter.Key">
|
||
<summary>
|
||
Required. The key of the metadata to filter on.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Metric">
|
||
<summary>
|
||
The metric used for running evaluations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.AggregationMetrics">
|
||
<summary>
|
||
Optional. The aggregation metrics to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.BleuSpec">
|
||
<summary>
|
||
Spec for bleu metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.ComputationBasedMetricSpec">
|
||
<summary>
|
||
Spec for a computation based metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.CustomCodeExecutionSpec">
|
||
<summary>
|
||
Spec for Custom Code Execution metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.ExactMatchSpec">
|
||
<summary>
|
||
Spec for exact match metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.LlmBasedMetricSpec">
|
||
<summary>
|
||
Spec for an LLM based metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.PairwiseMetricSpec">
|
||
<summary>
|
||
Spec for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.PointwiseMetricSpec">
|
||
<summary>
|
||
Spec for pointwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.PredefinedMetricSpec">
|
||
<summary>
|
||
The spec for a pre-defined metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Metric.RougeSpec">
|
||
<summary>
|
||
Spec for rouge metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.AggregationMetricUnspecified">
|
||
<summary>
|
||
Unspecified aggregation metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.Average">
|
||
<summary>
|
||
Average aggregation metric. Not supported for Pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.Mode">
|
||
<summary>
|
||
Mode aggregation metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.StandardDeviation">
|
||
<summary>
|
||
Standard deviation aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.Variance">
|
||
<summary>
|
||
Variance aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.Minimum">
|
||
<summary>
|
||
Minimum aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.Maximum">
|
||
<summary>
|
||
Maximum aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.Median">
|
||
<summary>
|
||
Median aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.PercentileP90">
|
||
<summary>
|
||
90th percentile aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.PercentileP95">
|
||
<summary>
|
||
95th percentile aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Metric.AggregationMetricsType.PercentileP99">
|
||
<summary>
|
||
99th percentile aggregation metric. Not supported for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Modality.ModalityUnspecified">
|
||
<summary>
|
||
Unspecified modality.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Modality.Text">
|
||
<summary>
|
||
Plain text.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Modality.Image">
|
||
<summary>
|
||
Image.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Modality.Video">
|
||
<summary>
|
||
Video.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Modality.Audio">
|
||
<summary>
|
||
Audio.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Modality.Document">
|
||
<summary>
|
||
Document, e.g. PDF.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Modality.Tabular">
|
||
<summary>
|
||
TABULAR modality
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModalityTokenCount">
|
||
<summary>
|
||
Represents token counting info for a single modality.
|
||
</summary>
|
||
<summary>
|
||
Represents token counting info for a single modality.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModalityTokenCount.Modality">
|
||
<summary>
|
||
The modality associated with this token count.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModalityTokenCount.TokenCount">
|
||
<summary>
|
||
Number of tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModalityTokenCount.ModalityType.ModalityUnspecified">
|
||
<summary>
|
||
Unspecified modality.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModalityTokenCount.ModalityType.Text">
|
||
<summary>
|
||
Plain text.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModalityTokenCount.ModalityType.Image">
|
||
<summary>
|
||
Image.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModalityTokenCount.ModalityType.Video">
|
||
<summary>
|
||
Video.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModalityTokenCount.ModalityType.Audio">
|
||
<summary>
|
||
Audio.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModalityTokenCount.ModalityType.Document">
|
||
<summary>
|
||
Document, e.g. PDF.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Mode.ModeUnspecified">
|
||
<summary>
|
||
Always trigger retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Mode.ModeDynamic">
|
||
<summary>
|
||
Run retrieval only when system decides it is necessary.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Mode.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.Types.Mode.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.Types.Mode.None">
|
||
<summary>
|
||
Model will not predict any function call. Model behavior is same as when not passing any function declarations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Mode.Validated">
|
||
<summary>
|
||
Model decides to predict either a function call or a natural language response, but will validate function calls with constrained decoding. 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="T:Mscc.GenerativeAI.Types.ModelArmorConfig">
|
||
<summary>
|
||
Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelArmorConfig.PromptTemplateName">
|
||
<summary>
|
||
Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format <c>projects/{project}/locations/{location}/templates/{template}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelArmorConfig.ResponseTemplateName">
|
||
<summary>
|
||
Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format <c>projects/{project}/locations/{location}/templates/{template}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelBaseModelSource">
|
||
<summary>
|
||
User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelBaseModelSource.GenieSource">
|
||
<summary>
|
||
Information about the base model of Genie models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelBaseModelSource.ModelGardenSource">
|
||
<summary>
|
||
Source information of Model Garden models.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelContainerSpec">
|
||
<summary>
|
||
Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.Args">
|
||
<summary>
|
||
Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [<c>CMD</c>](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker <c>CMD</c>'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the <c>command</c> field runs without any additional arguments. See the [Kubernetes documentation about how the <c>command</c> and <c>args</c> fields interact with a container's <c>ENTRYPOINT</c> and <c>CMD</c>](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the <c>command</c> field, then the container's [<c>ENTRYPOINT</c>](https://docs.docker.com/engine/reference/builder/#cmd) and <c>CMD</c> determine what runs based on their default behavior. See the Docker documentation about [how <c>CMD</c> and <c>ENTRYPOINT</c> interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with <c>$$</c>; for example: $$(VARIABLE_NAME) This field corresponds to the <c>args</c> field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.Command">
|
||
<summary>
|
||
Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker <c>ENTRYPOINT</c>'s "exec" form, not its "shell" form. If you do not specify this field, then the container's <c>ENTRYPOINT</c> runs, in conjunction with the args field or the container's [<c>CMD</c>](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an <c>ENTRYPOINT</c>, then refer to the Docker documentation about [how <c>CMD</c> and <c>ENTRYPOINT</c> interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the <c>args</c> field to provide additional arguments for this command. However, if you specify this field, then the container's <c>CMD</c> is ignored. See the [Kubernetes documentation about how the <c>command</c> and <c>args</c> fields interact with a container's <c>ENTRYPOINT</c> and <c>CMD</c>](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with <c>$$</c>; for example: $$(VARIABLE_NAME) This field corresponds to the <c>command</c> field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.DeploymentTimeout">
|
||
<summary>
|
||
Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.Env">
|
||
<summary>
|
||
Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable <c>VAR_2</c> to have the value <c>foo bar</c>: ``<c>json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] </c>`<c> If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the </c>env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.GrpcPorts">
|
||
<summary>
|
||
Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the <c>ports</c> field of the Kubernetes Containers v1 core API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.HealthProbe">
|
||
<summary>
|
||
Immutable. Specification for Kubernetes readiness probe.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.HealthRoute">
|
||
<summary>
|
||
Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to <c>/bar</c>, then Vertex AI intermittently sends a GET request to the <c>/bar</c> path on the port of your container specified by the first value of this <c>ModelContainerSpec</c>'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following <c>endpoints/</c>)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [<c>AIP_ENDPOINT_ID</c> environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the <c>DeployedModel</c>. (Vertex AI makes this value available to your container code as the [<c>AIP_DEPLOYED_MODEL_ID</c> environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.ImageUri">
|
||
<summary>
|
||
Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.InvokeRoutePrefix">
|
||
<summary>
|
||
Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not supported yet. Only one of <c>predict_route</c> or <c>invoke_route_prefix</c> can be set, and we default to using <c>predict_route</c> if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.LivenessProbe">
|
||
<summary>
|
||
Immutable. Specification for Kubernetes liveness probe.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.Ports">
|
||
<summary>
|
||
Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ``<c>json [ { "containerPort": 8080 } ] </c>`<c> Vertex AI does not use ports other than the first one listed. This field corresponds to the </c>ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.PredictRoute">
|
||
<summary>
|
||
Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to <c>/foo</c>, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the <c>/foo</c> path on the port of your container specified by the first value of this <c>ModelContainerSpec</c>'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following <c>endpoints/</c>)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [<c>AIP_ENDPOINT_ID</c> environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the <c>DeployedModel</c>. (Vertex AI makes this value available to your container code as the [<c>AIP_DEPLOYED_MODEL_ID</c> environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.SharedMemorySizeMb">
|
||
<summary>
|
||
Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelContainerSpec.StartupProbe">
|
||
<summary>
|
||
Immutable. Specification for Kubernetes startup probe.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelExportFormat">
|
||
<summary>
|
||
Represents export format supported by the Model. All formats export to Google Cloud Storage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelExportFormat.ExportableContents">
|
||
<summary>
|
||
Output only. The content of this Model that may be exported.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelExportFormat.Id">
|
||
<summary>
|
||
Output only. The ID of the export format. The possible format IDs are: * <c>tflite</c> Used for Android mobile devices. * <c>edgetpu-tflite</c> Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * <c>tf-saved-model</c> A tensorflow model in SavedModel format. * <c>tf-js</c> A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * <c>core-ml</c> Used for iOS mobile devices. * <c>custom-trained</c> A Model that was uploaded or trained by custom code. * <c>genie</c> A tuned Model Garden model.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelExportFormat.ExportableContentsType.ExportableContentUnspecified">
|
||
<summary>
|
||
Should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelExportFormat.ExportableContentsType.Artifact">
|
||
<summary>
|
||
Model artifact and any of its supported files. Will be exported to the location specified by the `artifactDestination` field of the ExportModelRequest.output_config object.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelExportFormat.ExportableContentsType.Image">
|
||
<summary>
|
||
The container image that is to be used when deploying this Model. Will be exported to the location specified by the `imageDestination` field of the ExportModelRequest.output_config object.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelGardenSource">
|
||
<summary>
|
||
Contains information about the source of the models generated from Model Garden.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelGardenSource.PublicModelName">
|
||
<summary>
|
||
Required. The model garden source model resource name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelGardenSource.SkipHfModelCache">
|
||
<summary>
|
||
Optional. Whether to avoid pulling the model from the HF cache.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelGardenSource.VersionId">
|
||
<summary>
|
||
Optional. The model garden source model version ID.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelOriginalModelInfo">
|
||
<summary>
|
||
Contains information about the original Model if this Model is a copy.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelOriginalModelInfo.Model">
|
||
<summary>
|
||
Output only. The resource name of the Model this Model is a copy of, including the revision. Format: <c>projects/{project}/locations/{location}/models/{model_id}@{version_id}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelResponse">
|
||
<summary>
|
||
A trained machine learning Model.
|
||
</summary>
|
||
<summary>
|
||
Information about a Generative Language Model.
|
||
Ref: https://ai.google.dev/api/rest/v1beta/models
|
||
</summary>
|
||
<summary>
|
||
Information about a Generative Language Model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.ArtifactUri">
|
||
<summary>
|
||
Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.BaseModelSource">
|
||
<summary>
|
||
Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Checkpoints">
|
||
<summary>
|
||
Optional. Output only. The checkpoints of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.ContainerSpec">
|
||
<summary>
|
||
Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.CreateTime">
|
||
<summary>
|
||
Output only. Timestamp when this Model was uploaded into Vertex AI.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.DefaultCheckpointId">
|
||
<summary>
|
||
The default checkpoint id of a model version.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.DeployedModels">
|
||
<summary>
|
||
Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.EncryptionSpec">
|
||
<summary>
|
||
Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.ExplanationSpec">
|
||
<summary>
|
||
The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Metadata">
|
||
<summary>
|
||
Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.MetadataArtifact">
|
||
<summary>
|
||
Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is <c>projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.MetadataSchemaUri">
|
||
<summary>
|
||
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.ModelSourceInfo">
|
||
<summary>
|
||
Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.OriginalModelInfo">
|
||
<summary>
|
||
Output only. If this Model is a copy of another Model, this contains info about the original.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.PredictSchemata">
|
||
<summary>
|
||
The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.SatisfiesPzi">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.SatisfiesPzs">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.SupportedDeploymentResourcesTypes">
|
||
<summary>
|
||
Output only. When this Model is deployed, its prediction resources are described by the <c>prediction_resources</c> field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.SupportedExportFormats">
|
||
<summary>
|
||
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.SupportedInputStorageFormats">
|
||
<summary>
|
||
Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * <c>jsonl</c> The JSON Lines format, where each instance is a single line. Uses GcsSource. * <c>csv</c> The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * <c>tf-record</c> The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * <c>tf-record-gzip</c> Similar to <c>tf-record</c>, but the file is gzipped. Uses GcsSource. * <c>bigquery</c> Each instance is a single row in BigQuery. Uses BigQuerySource. * <c>file-list</c> Each line of the file is the location of an instance to process, uses <c>gcs_source</c> field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.SupportedOutputStorageFormats">
|
||
<summary>
|
||
Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * <c>jsonl</c> The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * <c>csv</c> The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * <c>bigquery</c> Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.TrainingPipeline">
|
||
<summary>
|
||
Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.UpdateTime">
|
||
<summary>
|
||
Output only. Timestamp when this Model was most recently updated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.VersionAliases">
|
||
<summary>
|
||
User provided version aliases so that a model version can be referenced via alias (i.e. <c>projects/{project}/locations/{location}/models/{model_id}@{version_alias}</c> instead of auto-generated version id (i.e. <c>projects/{project}/locations/{location}/models/{model_id}@{version_id})</c>. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.VersionCreateTime">
|
||
<summary>
|
||
Output only. Timestamp when this version was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.VersionDescription">
|
||
<summary>
|
||
The description of this version.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.VersionUpdateTime">
|
||
<summary>
|
||
Output only. Timestamp when this version was most recently updated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelResponse.SupportedDeploymentResourcesTypesType.DeploymentResourcesTypeUnspecified">
|
||
<summary>
|
||
Should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelResponse.SupportedDeploymentResourcesTypesType.DedicatedResources">
|
||
<summary>
|
||
Resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelResponse.SupportedDeploymentResourcesTypesType.AutomaticResources">
|
||
<summary>
|
||
Resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelResponse.SupportedDeploymentResourcesTypesType.SharedResources">
|
||
<summary>
|
||
Resources that can be shared by multiple DeployedModels. A pre-configured DeploymentResourcePool is required.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.VersionId">
|
||
<summary>
|
||
The version Id of the model (Vertex AI).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.State">
|
||
<summary>
|
||
Output only. The state of the tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.TuningTask">
|
||
<summary>
|
||
Required. The tuning task that creates the tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.TunedModelSource">
|
||
<summary>
|
||
Optional. TunedModel to use as the starting point for training the new model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.BaseModel">
|
||
<summary>
|
||
The name of the base model, pass this to the generation request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.ETag">
|
||
<summary>
|
||
The ETag of the item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Labels">
|
||
<summary>
|
||
Optional. The labels with user-defined metadata for the request.
|
||
</summary>
|
||
<remarks>
|
||
It is used for billing and reporting only.
|
||
Label keys and values can be no longer than 63 characters (Unicode codepoints) and
|
||
can only contain lowercase letters, numeric characters, underscores, and dashes.
|
||
International characters are allowed. Label values are optional. Label keys must start with a letter.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.BaseModelId">
|
||
<summary>
|
||
Required. The name of the base model, pass this to the generation request. Examples: * <c>gemini-1.5-flash</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Description">
|
||
<summary>
|
||
A short description of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.DisplayName">
|
||
<summary>
|
||
The human-readable name of the model. E.g. "Gemini 1.5 Flash". The name can be up to 128 characters long and can consist of any UTF-8 characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.InputTokenLimit">
|
||
<summary>
|
||
Maximum number of input tokens allowed for this model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.MaxTemperature">
|
||
<summary>
|
||
The maximum temperature this model can use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Name">
|
||
<summary>
|
||
Required. The resource name of the <c>Model</c>. Refer to [Model variants](https://ai.google.dev/gemini-api/docs/models/gemini#model-variations) for all allowed values. Format: <c>models/{model}</c> with a <c>{model}</c> naming convention of: * "{base_model_id}-{version}" Examples: * <c>models/gemini-1.5-flash-001</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.OutputTokenLimit">
|
||
<summary>
|
||
Maximum number of output tokens available for this model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.SupportedGenerationMethods">
|
||
<summary>
|
||
The model's supported generation methods. The corresponding API method names are defined as Pascal case strings, such as <c>generateMessage</c> and <c>generateContent</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Temperature">
|
||
<summary>
|
||
Controls the randomness of the output. Values can range over <c>[0.0,max_temperature]</c>, inclusive. A higher value will produce responses that are more varied, while a value closer to <c>0.0</c> will typically result in less surprising responses from the model. This value specifies default to be used by the backend while making the call to the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Thinking">
|
||
<summary>
|
||
Whether the model supports thinking.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.TopK">
|
||
<summary>
|
||
For Top-k sampling. Top-k sampling considers the set of <c>top_k</c> most probable tokens. This value specifies default to be used by the backend while making the call to the model. If empty, indicates the model doesn't use top-k sampling, and <c>top_k</c> isn't allowed as a generation parameter.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.TopP">
|
||
<summary>
|
||
For [Nucleus sampling](https://ai.google.dev/gemini-api/docs/prompting-strategies#top-p). Nucleus sampling considers the smallest set of tokens whose probability sum is at least <c>top_p</c>. This value specifies default to be used by the backend while making the call to the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelResponse.Version">
|
||
<summary>
|
||
Required. The version number of the model. This represents the major version (<c>1.0</c> or <c>1.5</c>)
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelRoutingPreference.Unknown">
|
||
<summary>
|
||
Unspecified model routing preference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelRoutingPreference.PrioritizeQuality">
|
||
<summary>
|
||
The model will be selected to prioritize the quality of the response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelRoutingPreference.Balanced">
|
||
<summary>
|
||
The model will be selected to balance quality and cost.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelRoutingPreference.PrioritizeCost">
|
||
<summary>
|
||
The model will be selected to prioritize the cost of the request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelSourceInfo">
|
||
<summary>
|
||
Detail description of the source information of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelSourceInfo.Copy">
|
||
<summary>
|
||
If this Model is copy of another Model. If true then source_type pertains to the original.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelSourceInfo.SourceType">
|
||
<summary>
|
||
Type of the model source.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.ModelSourceTypeUnspecified">
|
||
<summary>
|
||
Should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.Automl">
|
||
<summary>
|
||
The Model is uploaded by automl training pipeline.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.Custom">
|
||
<summary>
|
||
The Model is uploaded by user or custom training pipeline.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.Bqml">
|
||
<summary>
|
||
The Model is registered and sync'ed from BigQuery ML.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.ModelGarden">
|
||
<summary>
|
||
The Model is saved or tuned from Model Garden.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.Genie">
|
||
<summary>
|
||
The Model is saved or tuned from Genie.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.CustomTextEmbedding">
|
||
<summary>
|
||
The Model is uploaded by text embedding finetuning pipeline.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelSourceInfo.ModelSourceInfoSourceType.Marketplace">
|
||
<summary>
|
||
The Model is saved or tuned from Marketplace.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ModelStatus">
|
||
<summary>
|
||
The status of the underlying model. This is used to indicate the stage of the underlying model and the retirement time if applicable.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelStatus.Message">
|
||
<summary>
|
||
A message explaining the model status.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelStatus.ModelStage">
|
||
<summary>
|
||
The stage of the underlying model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ModelStatus.RetirementTime">
|
||
<summary>
|
||
The time at which the model will be retired.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.ModelStageUnspecified">
|
||
<summary>
|
||
Unspecified model stage.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.UnstableExperimental">
|
||
<summary>
|
||
The underlying model is subject to lots of tunings.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.Experimental">
|
||
<summary>
|
||
Models in this stage are for experimental purposes only.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.Preview">
|
||
<summary>
|
||
Models in this stage are more mature than experimental models.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.Stable">
|
||
<summary>
|
||
Models in this stage are considered stable and ready for production use.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.Legacy">
|
||
<summary>
|
||
If the model is on this stage, it means that this model is on the path to deprecation in near future. Only existing customers can use this model.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.Deprecated">
|
||
<summary>
|
||
Models in this stage are deprecated. These models cannot be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ModelStatus.ModelStageType.Retired">
|
||
<summary>
|
||
Models in this stage are retired. These models cannot be used.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.MultiSpeakerVoiceConfig">
|
||
<summary>
|
||
Configuration for a multi-speaker text-to-speech request.
|
||
</summary>
|
||
<summary>
|
||
The configuration for the multi-speaker setup.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.MultiSpeakerVoiceConfig.SpeakerVoiceConfigs">
|
||
<summary>
|
||
Required. All the enabled speaker voices.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ObjectId">
|
||
<summary>
|
||
This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ObjectId.ObjectName">
|
||
<summary>
|
||
The name of the object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ObjectId.BucketName">
|
||
<summary>
|
||
The name of the bucket to which this object belongs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ObjectId.Generation">
|
||
<summary>
|
||
Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IOperation.Name">
|
||
<summary>
|
||
The server-assigned name, which is only unique within the same service that originally returns it.
|
||
If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IOperation.Done">
|
||
<summary>
|
||
If the value is `false`, it means the operation is still in progress.
|
||
If `true`, the operation is completed, and either `error` or `response` is available.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IOperation.Error">
|
||
<summary>
|
||
The error result of the operation in case of failure or cancellation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IOperation.Metadata">
|
||
<summary>
|
||
Service-specific metadata associated with the operation.
|
||
</summary>
|
||
<remarks>
|
||
It typically contains progress information and common metadata such as create time.
|
||
Some services might not provide such metadata. Any method that returns a long-running operation
|
||
should document the metadata type, if any.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.IOperation.Response">
|
||
<summary>
|
||
The normal, successful response of the operation.
|
||
</summary>
|
||
<remarks>
|
||
If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`.
|
||
If the original method is standard `Get`/`Create`/`Update`, the response should be the resource.
|
||
For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name.
|
||
For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Operation">
|
||
<summary>
|
||
This resource represents a long-running operation that is the result of a network API call.
|
||
</summary>
|
||
<summary>
|
||
This resource represents a long-running operation that is the result of a network API call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Operation.Done">
|
||
<summary>
|
||
If the value is <c>false</c>, it means the operation is still in progress. If <c>true</c>, the operation is completed, and either <c>error</c> or <c>response</c> is available.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Operation.Error">
|
||
<summary>
|
||
The error result of the operation in case of failure or cancellation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Operation.Metadata">
|
||
<summary>
|
||
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Operation.Name">
|
||
<summary>
|
||
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the <c>name</c> should be a resource name ending with <c>operations/{unique_id}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Operation.Response">
|
||
<summary>
|
||
The normal, successful response of the operation. If the original method returns no data on success, such as <c>Delete</c>, the response is <c>google.protobuf.Empty</c>. If the original method is standard <c>Get</c>/<c>Create</c>/<c>Update</c>, the response should be the resource. For other methods, the response should have the type <c>XxxResponse</c>, where <c>Xxx</c> is the original method name. For example, if the original method name is <c>TakeSnapshot()</c>, the inferred response type is <c>TakeSnapshotResponse</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Operation`1">
|
||
<summary>
|
||
This resource represents a long-running operation that is the result of a network API call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Operation`1.Response">
|
||
<summary>
|
||
The normal, successful response of the operation.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Operator">
|
||
<summary>
|
||
Defines the valid operators that can be applied to a key-value pair.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.OperatorUnspecified">
|
||
<summary>
|
||
The default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.Less">
|
||
<summary>
|
||
Supported by numeric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.LessEqual">
|
||
<summary>
|
||
Supported by numeric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.Equal">
|
||
<summary>
|
||
Supported by numeric and string.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.GreaterEqual">
|
||
<summary>
|
||
Supported by numeric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.Greater">
|
||
<summary>
|
||
Supported by numeric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.NotEqual">
|
||
<summary>
|
||
Supported by numeric and string.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.Includes">
|
||
<summary>
|
||
Supported by string only when <see cref="T:Mscc.GenerativeAI.Types.CustomMetadata" /> value type for the given key has a stringListValue.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Operator.Excludes">
|
||
<summary>
|
||
Supported by string only when <see cref="T:Mscc.GenerativeAI.Types.CustomMetadata" /> value type for the given key has a stringListValue.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Outcome.OutcomeUnspecified">
|
||
<summary>
|
||
Unspecified status. This value should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Outcome.OutcomeOk">
|
||
<summary>
|
||
Code execution completed successfully. `output` contains the stdout, if any.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Outcome.OutcomeFailed">
|
||
<summary>
|
||
Code execution failed. `output` contains the stderr and stdout, if any.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.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.Types.OutputConfig">
|
||
<summary>
|
||
Config for evaluation output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.OutputConfig.GcsDestination">
|
||
<summary>
|
||
Cloud storage destination for evaluation output.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.OutputInfo">
|
||
<summary>
|
||
Describes the info for output of EvaluationService.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.OutputInfo.GcsOutputDirectory">
|
||
<summary>
|
||
Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.OutputOptions">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.OutputOptions.MimeType">
|
||
<summary>
|
||
Optional. The IANA standard MIME type of the image.
|
||
</summary>
|
||
<remarks>Values:
|
||
image/jpeg
|
||
image/png
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.OutputOptions.CompressionQuality">
|
||
<summary>
|
||
Optional. The compression quality of the output image if encoding in image/jpeg.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PairwiseMetricResult">
|
||
<summary>
|
||
Spec for pairwise metric result.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricResult.CustomOutput">
|
||
<summary>
|
||
Output only. Spec for custom output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricResult.Explanation">
|
||
<summary>
|
||
Output only. Explanation for pairwise metric score.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricResult.PairwiseChoice">
|
||
<summary>
|
||
Output only. Pairwise metric choice.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PairwiseMetricResult.PairwiseChoiceType.PairwiseChoiceUnspecified">
|
||
<summary>
|
||
Unspecified prediction choice.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PairwiseMetricResult.PairwiseChoiceType.Baseline">
|
||
<summary>
|
||
Baseline prediction wins
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PairwiseMetricResult.PairwiseChoiceType.Candidate">
|
||
<summary>
|
||
Candidate prediction wins
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PairwiseMetricResult.PairwiseChoiceType.Tie">
|
||
<summary>
|
||
Winner cannot be determined
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PairwiseMetricSpec">
|
||
<summary>
|
||
Spec for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricSpec.BaselineResponseFieldName">
|
||
<summary>
|
||
Optional. The field name of the baseline response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricSpec.CandidateResponseFieldName">
|
||
<summary>
|
||
Optional. The field name of the candidate response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricSpec.CustomOutputFormatConfig">
|
||
<summary>
|
||
Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the <c>pairwise_choice</c> and <c>explanation</c> fields in the corresponding metric result will be empty.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricSpec.MetricPromptTemplate">
|
||
<summary>
|
||
Required. Metric prompt template for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PairwiseMetricSpec.SystemInstruction">
|
||
<summary>
|
||
Optional. System instructions for pairwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.TypeUnspecified">
|
||
<summary>
|
||
Not specified, should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.String">
|
||
<summary>
|
||
String type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.Number">
|
||
<summary>
|
||
Number type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.Integer">
|
||
<summary>
|
||
Integer type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.Boolean">
|
||
<summary>
|
||
Boolean type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.Array">
|
||
<summary>
|
||
Array type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.Object">
|
||
<summary>
|
||
Object type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ParameterType.Null">
|
||
<summary>
|
||
Null type.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Part">
|
||
<summary>
|
||
A datatype containing media that is part of a multi-part Content message. A <c>Part</c> consists of data which has an associated datatype. A <c>Part</c> can only contain one of the accepted types in <c>Part.data</c>. For media types that are not text, <c>Part</c> must have a fixed IANA MIME type identifying the type and subtype of the media if <c>inline_data</c> or <c>file_data</c> field is filled with raw bytes.
|
||
</summary>
|
||
<summary>
|
||
A datatype containing media that is part of a multi-part Content message.
|
||
A part of a turn in a conversation with the model with a fixed MIME type.
|
||
It has one of the following mutually exclusive fields:
|
||
1. text
|
||
2. inline_data
|
||
3. file_data
|
||
4. functionResponse
|
||
5. functionCall
|
||
</summary>
|
||
<remarks>
|
||
Exactly one field within a Part should be set,
|
||
representing the specific type of content being conveyed. Using multiple fields within the
|
||
same `Part` instance is considered invalid.
|
||
</remarks>
|
||
<summary>
|
||
A datatype containing media that is part of a multi-part <c>Content</c> message. A <c>Part</c> consists of data which has an associated datatype. A <c>Part</c> can only contain one of the accepted types in <c>Part.data</c>. A <c>Part</c> must have a fixed IANA MIME type identifying the type and subtype of the media if the <c>inline_data</c> field is filled with raw bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Part.#ctor(System.String)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="text"></param>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.Text">
|
||
<summary>
|
||
The text content of the part.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.TextData">
|
||
<remarks/>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.InlineData">
|
||
<summary>
|
||
Optional. The inline data content of the part. This can be used to include images, audio, or
|
||
video in a request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.ETag">
|
||
<summary>
|
||
The ETag of the item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.CodeExecutionResult">
|
||
<summary>
|
||
Result of executing the <c>ExecutableCode</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.ExecutableCode">
|
||
<summary>
|
||
Code generated by the model that is meant to be executed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.FileData">
|
||
<summary>
|
||
URI based data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.FunctionCall">
|
||
<summary>
|
||
A predicted <c>FunctionCall</c> returned from the model that contains a string representing the <c>FunctionDeclaration.name</c> with the arguments and their values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.FunctionResponse">
|
||
<summary>
|
||
The result output of a <c>FunctionCall</c> that contains a string representing the <c>FunctionDeclaration.name</c> and a structured JSON object containing any output from the function is used as context to the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.MediaResolution">
|
||
<summary>
|
||
Optional. Media resolution for the input media.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.PartMetadata">
|
||
<summary>
|
||
Custom metadata associated with the Part. Agents using genai.Part as content representation may need to keep track of the additional information. For example it can be name of a file/source from which the Part originates or a way to multiplex multiple Part streams.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.Thought">
|
||
<summary>
|
||
Optional. Indicates if the part is thought from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.ThoughtSignature">
|
||
<summary>
|
||
Optional. An opaque signature for the thought so it can be reused in subsequent requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Part.VideoMetadata">
|
||
<summary>
|
||
Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PartialArg">
|
||
<summary>
|
||
Partial argument value of the function call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartialArg.BoolValue">
|
||
<summary>
|
||
Optional. Represents a boolean value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartialArg.JsonPath">
|
||
<summary>
|
||
Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartialArg.NullValue">
|
||
<summary>
|
||
Optional. Represents a null value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartialArg.NumberValue">
|
||
<summary>
|
||
Optional. Represents a double value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartialArg.StringValue">
|
||
<summary>
|
||
Optional. Represents a string value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartialArg.WillContinue">
|
||
<summary>
|
||
Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PartialArg.NullValueType.NullValue">
|
||
<summary>
|
||
Null value.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PartnerModelTuningSpec">
|
||
<summary>
|
||
Tuning spec for Partner models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartnerModelTuningSpec.HyperParameters">
|
||
<summary>
|
||
Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartnerModelTuningSpec.TrainingDatasetUri">
|
||
<summary>
|
||
Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PartnerModelTuningSpec.ValidationDatasetUri">
|
||
<summary>
|
||
Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Permission">
|
||
<summary>
|
||
Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, corpus). A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains. There are three concentric roles. Each role is a superset of the previous role's permitted operations: - reader can use the resource (e.g. tuned model, corpus) for inference - writer has reader's permissions and additionally can edit and share - owner has writer's permissions and additionally can delete
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Permission.EmailAddress">
|
||
<summary>
|
||
Optional. Immutable. The email address of the user of group which this permission refers. Field is not set when permission's grantee type is EVERYONE.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Permission.GranteeType">
|
||
<summary>
|
||
Optional. Immutable. The type of the grantee.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Permission.Name">
|
||
<summary>
|
||
Output only. Identifier. The permission name. A unique name will be generated on create. Examples: tunedModels/{tuned_model}/permissions/{permission} corpora/{corpus}/permissions/{permission} Output only.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Permission.Role">
|
||
<summary>
|
||
Required. The role granted by this permission.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Permission.PermissionGranteeType.GranteeTypeUnspecified">
|
||
<summary>
|
||
The default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Permission.PermissionGranteeType.User">
|
||
<summary>
|
||
Represents a user. When set, you must provide email_address for the user.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Permission.PermissionGranteeType.Group">
|
||
<summary>
|
||
Represents a group. When set, you must provide email_address for the group.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Permission.PermissionGranteeType.Everyone">
|
||
<summary>
|
||
Represents access to everyone. No extra information is required.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PermissionRole.RoleUnspecified">
|
||
<summary>
|
||
The default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PermissionRole.Owner">
|
||
<summary>
|
||
Owner can use, update, share and delete the resource.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PermissionRole.Writer">
|
||
<summary>
|
||
Writer can use, update and share the resource.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PermissionRole.Reader">
|
||
<summary>
|
||
Reader can use the resource.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PersonGeneration.PersonGenerationUnspecified">
|
||
<summary>
|
||
The default behavior is unspecified. The model will decide whether to generate images of people.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PersonGeneration.AllowAll">
|
||
<summary>
|
||
Allows the model to generate images of people, including adults and children.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PersonGeneration.AllowAdult">
|
||
<summary>
|
||
Allows the model to generate images of adults, but not children.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.PersonGeneration.AllowNone">
|
||
<summary>
|
||
Prevents the model from generating images of people.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Pinecone">
|
||
<summary>
|
||
Specifies your Pinecone instance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Pinecone.IndexName">
|
||
<summary>
|
||
This is the name used to create the Pinecone index that's used with the RAG corpus.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PlaceAnswerSources">
|
||
<summary>
|
||
Collection of sources that provide answers about the features of a given place in Google Maps. Each PlaceAnswerSources message corresponds to a specific place in Google Maps. The Google Maps tool used these sources in order to answer questions about features of the place (e.g: "does Bar Foo have Wifi" or "is Foo Bar wheelchair accessible?"). Currently we only support review snippets as sources.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PlaceAnswerSources.ReviewSnippets">
|
||
<summary>
|
||
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PointwiseMetricResult">
|
||
<summary>
|
||
Spec for pointwise metric result.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PointwiseMetricResult.CustomOutput">
|
||
<summary>
|
||
Output only. Spec for custom output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PointwiseMetricResult.Explanation">
|
||
<summary>
|
||
Output only. Explanation for pointwise metric score.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PointwiseMetricResult.Score">
|
||
<summary>
|
||
Output only. Pointwise metric score.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PointwiseMetricSpec">
|
||
<summary>
|
||
Spec for pointwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PointwiseMetricSpec.CustomOutputFormatConfig">
|
||
<summary>
|
||
Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the <c>score</c> and <c>explanation</c> fields in the corresponding metric result will be empty.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PointwiseMetricSpec.MetricPromptTemplate">
|
||
<summary>
|
||
Required. Metric prompt template for pointwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PointwiseMetricSpec.SystemInstruction">
|
||
<summary>
|
||
Optional. System instructions for pointwise metric.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Port">
|
||
<summary>
|
||
Represents a network port in a container.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Port.ContainerPort">
|
||
<summary>
|
||
The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PrebuiltVoiceConfig">
|
||
<summary>
|
||
Configuration for a prebuilt voice.
|
||
</summary>
|
||
<summary>
|
||
The configuration for the prebuilt speaker to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PrebuiltVoiceConfig.VoiceName">
|
||
<summary>
|
||
The name of the preset voice to use.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PredefinedMetricSpec">
|
||
<summary>
|
||
The spec for a pre-defined metric.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredefinedMetricSpec.MetricSpecName">
|
||
<summary>
|
||
Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredefinedMetricSpec.MetricSpecParameters">
|
||
<summary>
|
||
Optional. The parameters needed to run the pre-defined metric.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PredictLongRunningRequest">
|
||
<summary>
|
||
Request message for PredictionService.PredictLongRunning.
|
||
</summary>
|
||
<summary>
|
||
Request message for [PredictionService.PredictLongRunning].
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictLongRunningRequest.Instances">
|
||
<summary>
|
||
Required. The instances that are the input to the prediction call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictLongRunningRequest.Parameters">
|
||
<summary>
|
||
Optional. The parameters that govern the prediction call.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PredictRequest">
|
||
<summary>
|
||
Request message for PredictionService.Predict.
|
||
</summary>
|
||
<summary>
|
||
Request message for PredictionService.Predict.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictRequest.Labels">
|
||
<summary>
|
||
Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictRequest.Instances">
|
||
<summary>
|
||
Required. The instances that are the input to the prediction call.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictRequest.Parameters">
|
||
<summary>
|
||
Optional. The parameters that govern the prediction call.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PredictResponse">
|
||
<summary>
|
||
Response message for PredictionService.Predict.
|
||
</summary>
|
||
<summary>
|
||
Response message for [PredictionService.Predict].
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictResponse.DeployedModelId">
|
||
<summary>
|
||
ID of the Endpoint's DeployedModel that served this prediction.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictResponse.Metadata">
|
||
<summary>
|
||
Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictResponse.Model">
|
||
<summary>
|
||
Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictResponse.ModelDisplayName">
|
||
<summary>
|
||
Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictResponse.ModelVersionId">
|
||
<summary>
|
||
Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictResponse.Predictions">
|
||
<summary>
|
||
The outputs of the prediction call.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PredictSchemata">
|
||
<summary>
|
||
Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictSchemata.InstanceSchemaUri">
|
||
<summary>
|
||
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictSchemata.ParametersSchemaUri">
|
||
<summary>
|
||
Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PredictSchemata.PredictionSchemaUri">
|
||
<summary>
|
||
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats">
|
||
<summary>
|
||
Statistics computed for datasets used for preference optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.DroppedExampleIndices">
|
||
<summary>
|
||
Output only. A partial sample of the indices (starting from 1) of the dropped examples.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.DroppedExampleReasons">
|
||
<summary>
|
||
Output only. For each index in <c>dropped_example_indices</c>, the user-facing reason why the example was dropped.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.ScoreVariancePerExampleDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for scores variance per example.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.ScoresDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for scores.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.TotalBillableTokenCount">
|
||
<summary>
|
||
Output only. Number of billable tokens in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.TuningDatasetExampleCount">
|
||
<summary>
|
||
Output only. Number of examples in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.TuningStepCount">
|
||
<summary>
|
||
Output only. Number of tuning steps for this Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.UserDatasetExamples">
|
||
<summary>
|
||
Output only. Sample user examples in the training dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.UserInputTokenDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the user input tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationDataStats.UserOutputTokenDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the user output tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PreferenceOptimizationHyperParameters">
|
||
<summary>
|
||
Hyperparameters for Preference Optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationHyperParameters.AdapterSize">
|
||
<summary>
|
||
Optional. Adapter size for preference optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationHyperParameters.Beta">
|
||
<summary>
|
||
Optional. Weight for KL Divergence regularization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationHyperParameters.EpochCount">
|
||
<summary>
|
||
Optional. Number of complete passes the model makes over the entire training dataset during training.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationHyperParameters.LearningRateMultiplier">
|
||
<summary>
|
||
Optional. Multiplier for adjusting the default learning rate.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PreferenceOptimizationSpec">
|
||
<summary>
|
||
Tuning Spec for Preference Optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationSpec.ExportLastCheckpointOnly">
|
||
<summary>
|
||
Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationSpec.HyperParameters">
|
||
<summary>
|
||
Optional. Hyperparameters for Preference Optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationSpec.TrainingDatasetUri">
|
||
<summary>
|
||
Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreferenceOptimizationSpec.ValidationDatasetUri">
|
||
<summary>
|
||
Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Presets">
|
||
<summary>
|
||
Preset configuration for example-based explanations
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Presets.Modality">
|
||
<summary>
|
||
The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Presets.Query">
|
||
<summary>
|
||
Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to <c>PRECISE</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Presets.ModalityType.ModalityUnspecified">
|
||
<summary>
|
||
Should not be set. Added as a recommended best practice for enums
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Presets.ModalityType.Image">
|
||
<summary>
|
||
IMAGE modality
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Presets.ModalityType.Text">
|
||
<summary>
|
||
TEXT modality
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Presets.ModalityType.Tabular">
|
||
<summary>
|
||
TABULAR modality
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Presets.QueryType.Precise">
|
||
<summary>
|
||
More precise neighbors as a trade-off against slower response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Presets.QueryType.Fast">
|
||
<summary>
|
||
Faster response as a trade-off against less precise neighbors.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PreTunedModel">
|
||
<summary>
|
||
A pre-tuned model for continuous tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreTunedModel.BaseModel">
|
||
<summary>
|
||
Output only. The name of the base model this PreTunedModel was tuned from.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreTunedModel.CheckpointId">
|
||
<summary>
|
||
Optional. The source checkpoint id. If not specified, the default checkpoint will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PreTunedModel.TunedModelName">
|
||
<summary>
|
||
The resource name of the Model. E.g., a model resource name with a specified version id or alias: <c>projects/{project}/locations/{location}/models/{model}@{version_id}</c> <c>projects/{project}/locations/{location}/models/{model}@{alias}</c> Or, omit the version id to use the default version: <c>projects/{project}/locations/{location}/models/{model}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ProactivityConfig">
|
||
<summary>
|
||
Config for proactivity features.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProactivityConfig.ProactiveAudio">
|
||
<summary>
|
||
Optional. If enabled, the model can reject responding to the last prompt. For example, this allows the model to ignore out of context speech or to stay silent if the user did not make a request, yet.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Probe">
|
||
<summary>
|
||
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.Exec">
|
||
<summary>
|
||
ExecAction probes the health of a container by executing a command.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.FailureThreshold">
|
||
<summary>
|
||
Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.Grpc">
|
||
<summary>
|
||
GrpcAction probes the health of a container by sending a gRPC request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.HttpGet">
|
||
<summary>
|
||
HttpGetAction probes the health of a container by sending an HTTP GET request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.InitialDelaySeconds">
|
||
<summary>
|
||
Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.PeriodSeconds">
|
||
<summary>
|
||
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.SuccessThreshold">
|
||
<summary>
|
||
Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.TcpSocket">
|
||
<summary>
|
||
TcpSocketAction probes the health of a container by opening a TCP socket connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Probe.TimeoutSeconds">
|
||
<summary>
|
||
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ProbeExecAction">
|
||
<summary>
|
||
ExecAction specifies a command to execute.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeExecAction.Command">
|
||
<summary>
|
||
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ProbeGrpcAction">
|
||
<summary>
|
||
GrpcAction checks the health of a container using a gRPC service.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeGrpcAction.Port">
|
||
<summary>
|
||
Port number of the gRPC service. Number must be in the range 1 to 65535.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeGrpcAction.Service">
|
||
<summary>
|
||
Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ProbeHttpGetAction">
|
||
<summary>
|
||
HttpGetAction describes an action based on HTTP Get requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeHttpGetAction.Host">
|
||
<summary>
|
||
Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeHttpGetAction.HttpHeaders">
|
||
<summary>
|
||
Custom headers to set in the request. HTTP allows repeated headers.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeHttpGetAction.Path">
|
||
<summary>
|
||
Path to access on the HTTP server.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeHttpGetAction.Port">
|
||
<summary>
|
||
Number of the port to access on the container. Number must be in the range 1 to 65535.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeHttpGetAction.Scheme">
|
||
<summary>
|
||
Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ProbeHttpHeader">
|
||
<summary>
|
||
HttpHeader describes a custom header to be used in HTTP probes
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeHttpHeader.Name">
|
||
<summary>
|
||
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeHttpHeader.Value">
|
||
<summary>
|
||
The header field value
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ProbeTcpSocketAction">
|
||
<summary>
|
||
TcpSocketAction probes the health of a container by opening a TCP socket connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeTcpSocketAction.Host">
|
||
<summary>
|
||
Optional: Host name to connect to, defaults to the model serving container's IP.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ProbeTcpSocketAction.Port">
|
||
<summary>
|
||
Number of the port to access on the container. Number must be in the range 1 to 65535.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ProductImage">
|
||
<summary>
|
||
An image of the product.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.PromptFeedback">
|
||
<summary>
|
||
A set of the feedback metadata the prompt specified in <see cref="!:GenerateContentRequest.content"/>.
|
||
</summary>
|
||
<summary>
|
||
A set of the feedback metadata the prompt specified in <c>GenerateContentRequest.content</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PromptFeedback.BlockReasonMessage">
|
||
<summary>
|
||
Output only. A readable block reason message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PromptFeedback.BlockReason">
|
||
<summary>
|
||
Optional. If set, the prompt was blocked and no candidates are returned. Rephrase the prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.PromptFeedback.SafetyRatings">
|
||
<summary>
|
||
Ratings for safety of the prompt. There is at most one rating per category.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.QueryCorpusRequest">
|
||
<summary>
|
||
Request for querying a <see cref="T:Mscc.GenerativeAI.Types.Corpus"/>.
|
||
</summary>
|
||
</member>
|
||
<!-- Badly formed XML comment ignored for member "P:Mscc.GenerativeAI.Types.QueryCorpusRequest.MetadataFilters" -->
|
||
<member name="P:Mscc.GenerativeAI.Types.QueryCorpusRequest.Query">
|
||
<summary>
|
||
Required. Query string to perform semantic search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.QueryCorpusRequest.ResultsCount">
|
||
<summary>
|
||
Optional. The maximum number of <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s to return. The service may return fewer <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s. If unspecified, at most 10 <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s will be returned. The maximum specified result count is 100.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.QueryCorpusResponse">
|
||
<summary>
|
||
Response from <see cref="!:QueryCorpus"/> containing a list of relevant chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.QueryCorpusResponse.RelevantChunks">
|
||
<summary>
|
||
The relevant chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.QueryDocumentRequest">
|
||
<summary>
|
||
Request for querying a <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
</member>
|
||
<!-- Badly formed XML comment ignored for member "P:Mscc.GenerativeAI.Types.QueryDocumentRequest.MetadataFilters" -->
|
||
<member name="P:Mscc.GenerativeAI.Types.QueryDocumentRequest.Query">
|
||
<summary>
|
||
Required. Query string to perform semantic search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.QueryDocumentRequest.ResultsCount">
|
||
<summary>
|
||
Optional. The maximum number of <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s to return. The service may return fewer <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s. If unspecified, at most 10 <see cref="T:Mscc.GenerativeAI.Types.Chunk"/>s will be returned. The maximum specified result count is 100.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.QueryDocumentResponse">
|
||
<summary>
|
||
Response from <see cref="!:QueryDocument"/> containing a list of relevant chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.QueryDocumentResponse.RelevantChunks">
|
||
<summary>
|
||
The returned relevant chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagChunk">
|
||
<summary>
|
||
A RagChunk includes the content of a chunk of a RagFile, and associated metadata.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagChunk.PageSpan">
|
||
<summary>
|
||
If populated, represents where the chunk starts and ends in the document.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagChunk.Text">
|
||
<summary>
|
||
The content of the chunk.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagChunkPageSpan">
|
||
<summary>
|
||
Represents where the chunk starts and ends in the document.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagChunkPageSpan.FirstPage">
|
||
<summary>
|
||
Page where chunk starts in the document. Inclusive. 1-indexed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagChunkPageSpan.LastPage">
|
||
<summary>
|
||
Page where chunk ends in the document. Inclusive. 1-indexed.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagCorpus">
|
||
<summary>
|
||
A RagCorpus is a RagFile container and a project can have multiple RagCorpora.
|
||
</summary>
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.CorpusStatus">
|
||
<summary>
|
||
Output only. RagCorpus state.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.CorpusTypeConfig">
|
||
<summary>
|
||
Optional. The corpus type config of the RagCorpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.CreateTime">
|
||
<summary>
|
||
Output only. Timestamp when this RagCorpus was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.Description">
|
||
<summary>
|
||
Optional. The description of the RagCorpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.DisplayName">
|
||
<summary>
|
||
Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.EncryptionSpec">
|
||
<summary>
|
||
Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.Name">
|
||
<summary>
|
||
Output only. The resource name of the RagCorpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.RagEmbeddingModelConfig">
|
||
<summary>
|
||
Optional. Immutable. The embedding model config of the RagCorpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.RagFilesCount">
|
||
<summary>
|
||
Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.RagVectorDbConfig">
|
||
<summary>
|
||
Optional. Immutable. The Vector DB config of the RagCorpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.SatisfiesPzi">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.SatisfiesPzs">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.UpdateTime">
|
||
<summary>
|
||
Output only. Timestamp when this RagCorpus was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.VectorDbConfig">
|
||
<summary>
|
||
Optional. Immutable. The config for the Vector DBs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpus.VertexAiSearchConfig">
|
||
<summary>
|
||
Optional. Immutable. The config for the Vertex AI Search.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagCorpusCorpusTypeConfig">
|
||
<summary>
|
||
The config for the corpus type of the RagCorpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpusCorpusTypeConfig.DocumentCorpus">
|
||
<summary>
|
||
Optional. Config for the document corpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpusCorpusTypeConfig.MemoryCorpus">
|
||
<summary>
|
||
Optional. Config for the memory corpus.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagCorpusCorpusTypeConfigDocumentCorpus">
|
||
<summary>
|
||
Config for the document corpus.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagCorpusCorpusTypeConfigMemoryCorpus">
|
||
<summary>
|
||
Config for the memory corpus.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagCorpusCorpusTypeConfigMemoryCorpus.LlmParser">
|
||
<summary>
|
||
The LLM parser to use for the memory corpus.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagEmbeddingModelConfig">
|
||
<summary>
|
||
Config for the embedding model to use for RAG.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfig.HybridSearchConfig">
|
||
<summary>
|
||
Configuration for hybrid search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfig.VertexPredictionEndpoint">
|
||
<summary>
|
||
The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigHybridSearchConfig">
|
||
<summary>
|
||
Config for hybrid search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigHybridSearchConfig.DenseEmbeddingModelPredictionEndpoint">
|
||
<summary>
|
||
Required. The Vertex AI Prediction Endpoint that hosts the embedding model for dense embedding generations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigHybridSearchConfig.SparseEmbeddingConfig">
|
||
<summary>
|
||
Optional. The configuration for sparse embedding generation. This field is optional the default behavior depends on the vector database choice on the RagCorpus.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigSparseEmbeddingConfig">
|
||
<summary>
|
||
Configuration for sparse emebdding generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigSparseEmbeddingConfig.Bm25">
|
||
<summary>
|
||
Use BM25 scoring algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigSparseEmbeddingConfigBm25">
|
||
<summary>
|
||
Message for BM25 parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigSparseEmbeddingConfigBm25.B">
|
||
<summary>
|
||
Optional. The parameter to control document length normalization. It determines how much the document length affects the final score. b is in the range of [0, 1]. The default value is 0.75.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigSparseEmbeddingConfigBm25.K1">
|
||
<summary>
|
||
Optional. The parameter to control term frequency saturation. It determines the scaling between the matching term frequency and final score. k1 is in the range of [1.2, 3]. The default value is 1.2.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigSparseEmbeddingConfigBm25.Multilingual">
|
||
<summary>
|
||
Optional. Use multilingual tokenizer if set to true.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigVertexPredictionEndpoint">
|
||
<summary>
|
||
Config representing a model hosted on Vertex Prediction Endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigVertexPredictionEndpoint.Endpoint">
|
||
<summary>
|
||
Required. The endpoint resource name. Format: <c>projects/{project}/locations/{location}/publishers/{publisher}/models/{model}</c> or <c>projects/{project}/locations/{location}/endpoints/{endpoint}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigVertexPredictionEndpoint.Model">
|
||
<summary>
|
||
Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: <c>projects/{project}/locations/{location}/models/{model}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagEmbeddingModelConfigVertexPredictionEndpoint.ModelVersionId">
|
||
<summary>
|
||
Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagFile">
|
||
<summary>
|
||
A RagFile contains user data for chunking, embedding and indexing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.CreateTime">
|
||
<summary>
|
||
Output only. Timestamp when this RagFile was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.Description">
|
||
<summary>
|
||
Optional. The description of the RagFile.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.DirectUploadSource">
|
||
<summary>
|
||
Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.DisplayName">
|
||
<summary>
|
||
Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.FileStatus">
|
||
<summary>
|
||
Output only. State of the RagFile.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.GcsSource">
|
||
<summary>
|
||
Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.GoogleDriveSource">
|
||
<summary>
|
||
Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.JiraSource">
|
||
<summary>
|
||
The RagFile is imported from a Jira query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.Name">
|
||
<summary>
|
||
Output only. The resource name of the RagFile.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.RagFileType">
|
||
<summary>
|
||
Output only. The type of the RagFile.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.SharePointSources">
|
||
<summary>
|
||
The RagFile is imported from a SharePoint source.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.SizeBytes">
|
||
<summary>
|
||
Output only. The size of the RagFile in bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.SlackSource">
|
||
<summary>
|
||
The RagFile is imported from a Slack channel.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.UpdateTime">
|
||
<summary>
|
||
Output only. Timestamp when this RagFile was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFile.UserMetadata">
|
||
<summary>
|
||
Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RagFile.RagFileRagFileType.RagFileTypeUnspecified">
|
||
<summary>
|
||
RagFile type is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RagFile.RagFileRagFileType.RagFileTypeTxt">
|
||
<summary>
|
||
RagFile type is TXT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RagFile.RagFileRagFileType.RagFileTypePdf">
|
||
<summary>
|
||
RagFile type is PDF.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagFileParsingConfigLlmParser">
|
||
<summary>
|
||
Specifies the LLM parsing for RagFiles.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFileParsingConfigLlmParser.CustomParsingPrompt">
|
||
<summary>
|
||
The prompt to use for parsing. If not specified, a default prompt will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFileParsingConfigLlmParser.GlobalMaxParsingRequestsPerMin">
|
||
<summary>
|
||
The maximum number of requests the job is allowed to make to the LLM model per minute in this project. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline job as the global limit.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFileParsingConfigLlmParser.MaxParsingRequestsPerMin">
|
||
<summary>
|
||
The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagFileParsingConfigLlmParser.ModelName">
|
||
<summary>
|
||
The name of a LLM model used for parsing. Format: * <c>projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagQuery">
|
||
<summary>
|
||
A query to retrieve relevant contexts.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagQuery.RagRetrievalConfig">
|
||
<summary>
|
||
Optional. The retrieval config for the query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagQuery.Ranking">
|
||
<summary>
|
||
Optional. Configurations for hybrid search results ranking.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagQuery.SimilarityTopK">
|
||
<summary>
|
||
Optional. The number of contexts to retrieve.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagQuery.Text">
|
||
<summary>
|
||
Optional. The query in text format to get relevant contexts.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagQueryRanking">
|
||
<summary>
|
||
Configurations for hybrid search results ranking.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagQueryRanking.Alpha">
|
||
<summary>
|
||
Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagResource">
|
||
<summary>
|
||
The definition of the Rag resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagResource.RagCorpus">
|
||
<summary>
|
||
Optional. RagCorpora resource name.
|
||
</summary>
|
||
<remarks>
|
||
Format: projects/{project}/locations/{location}/ragCorpora/{ragCorpus}
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagResource.RagFileIds">
|
||
<summary>
|
||
Optional. ragFileId. The files should be in the same ragCorpus set in ragCorpus field.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagRetrievalConfig">
|
||
<summary>
|
||
Specifies the context retrieval config.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfig.Filter">
|
||
<summary>
|
||
Optional. Config for filters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfig.HybridSearch">
|
||
<summary>
|
||
Optional. Config for Hybrid Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfig.Ranking">
|
||
<summary>
|
||
Optional. Config for ranking and reranking.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfig.TopK">
|
||
<summary>
|
||
Optional. The number of contexts to retrieve.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagRetrievalConfigFilter">
|
||
<summary>
|
||
Config for filters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigFilter.MetadataFilter">
|
||
<summary>
|
||
Optional. String for metadata filtering.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigFilter.VectorDistanceThreshold">
|
||
<summary>
|
||
Optional. Only returns contexts with vector distance smaller than the threshold.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigFilter.VectorSimilarityThreshold">
|
||
<summary>
|
||
Optional. Only returns contexts with vector similarity larger than the threshold.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagRetrievalConfigHybridSearch">
|
||
<summary>
|
||
Config for Hybrid Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigHybridSearch.Alpha">
|
||
<summary>
|
||
Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagRetrievalConfigRanking">
|
||
<summary>
|
||
Config for ranking and reranking.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigRanking.LlmRanker">
|
||
<summary>
|
||
Optional. Config for LlmRanker.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigRanking.RankService">
|
||
<summary>
|
||
Optional. Config for Rank Service.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagRetrievalConfigRankingLlmRanker">
|
||
<summary>
|
||
Config for LlmRanker.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigRankingLlmRanker.ModelName">
|
||
<summary>
|
||
Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagRetrievalConfigRankingRankService">
|
||
<summary>
|
||
Config for Rank Service.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagRetrievalConfigRankingRankService.ModelName">
|
||
<summary>
|
||
Optional. The model name of the rank service. Format: <c>semantic-ranker-512@latest</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListRagStoresResponse">
|
||
<summary>
|
||
Response from `ListRagStores` containing a paginated list of `RagStores`.
|
||
The results are sorted by ascending `rag_store.create_time`.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagStoresResponse.RagStores">
|
||
<summary>
|
||
The returned rag_stores.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ListRagStoresResponse.NextPageToken">
|
||
<summary>
|
||
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagStore">
|
||
<summary>
|
||
A `RagStore` is a collection of `Document`s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.Name">
|
||
<summary>
|
||
Output only. Immutable. Identifier. The `RagStore` resource name.
|
||
</summary>
|
||
<remarks>
|
||
It is an ID (name excluding the "ragStores/" prefix) that can contain up to 40 characters that are
|
||
lowercase alphanumeric or dashes (-). It is output only. The unique name will be derived from
|
||
`display_name` along with a 12 character random suffix. Example: `ragStores/my-awesome-rag-store-123a456b789c`
|
||
If `display_name` is not provided, the name will be randomly generated.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.DisplayName">
|
||
<summary>
|
||
Optional. The human-readable display name for the `RagStore`. The display name must be no more than 512 characters in length, including spaces. Example: "Docs on Semantic Retriever"
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.ActiveDocumentsCount">
|
||
<summary>
|
||
Output only. The number of documents in the Ragstore that are active and ready for retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.FailedDocumentsCount">
|
||
<summary>
|
||
Output only. The number of documents in the Ragstore that have failed processing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.PendingDocumentsCount">
|
||
<summary>
|
||
Output only. The number of documents in the Ragstore that are being processed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.SizeBytes">
|
||
<summary>
|
||
Output only. The size in bytes of the Ragstore. This is the total size of all the documents in the Ragstore.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.CreateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the `RagStore` was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagStore.UpdateTime">
|
||
<summary>
|
||
Output only. The Timestamp of when the `RagStore` was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfig">
|
||
<summary>
|
||
Config for the Vector DB to use for RAG.
|
||
</summary>
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.ApiAuth">
|
||
<summary>
|
||
Authentication config for the chosen Vector DB.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.Pinecone">
|
||
<summary>
|
||
The config for the Pinecone.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.RagEmbeddingModelConfig">
|
||
<summary>
|
||
Optional. Immutable. The embedding model config of the Vector DB.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.RagManagedDb">
|
||
<summary>
|
||
The config for the RAG-managed Vector DB.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.RagManagedVertexVectorSearch">
|
||
<summary>
|
||
The config for the RAG-managed Vertex Vector Search 2.0.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.VertexFeatureStore">
|
||
<summary>
|
||
The config for the Vertex Feature Store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.VertexVectorSearch">
|
||
<summary>
|
||
The config for the Vertex Vector Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfig.Weaviate">
|
||
<summary>
|
||
The config for the Weaviate.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigPinecone">
|
||
<summary>
|
||
The config for the Pinecone.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigPinecone.IndexName">
|
||
<summary>
|
||
Pinecone index name. This value cannot be changed after it's set.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedDb">
|
||
<summary>
|
||
The config for the default RAG-managed Vector DB.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedDb.Ann">
|
||
<summary>
|
||
Performs an ANN search on RagCorpus. Use this if you have a lot of files (> 10K) in your RagCorpus and want to reduce the search latency.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedDb.Knn">
|
||
<summary>
|
||
Performs a KNN search on RagCorpus. Default choice if not specified.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedDbANN">
|
||
<summary>
|
||
Config for ANN search. RagManagedDb uses a tree-based structure to partition data and facilitate faster searches. As a tradeoff, it requires longer indexing time and manual triggering of index rebuild via the ImportRagFiles and UpdateRagCorpus API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedDbANN.LeafCount">
|
||
<summary>
|
||
Number of leaf nodes in the tree-based structure. Each leaf node contains groups of closely related vectors along with their corresponding centroid. Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus). Default value is 500.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedDbANN.TreeDepth">
|
||
<summary>
|
||
The depth of the tree-based structure. Only depth values of 2 and 3 are supported. Recommended value is 2 if you have if you have O(10K) files in the RagCorpus and set this to 3 if more than that. Default value is 2.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedDbKNN">
|
||
<summary>
|
||
Config for KNN search.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedVertexVectorSearch">
|
||
<summary>
|
||
The config for the RAG-managed Vertex Vector Search 2.0.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigRagManagedVertexVectorSearch.CollectionName">
|
||
<summary>
|
||
Output only. The resource name of the Vector Search 2.0 Collection that RAG Created for the corpus. Only populated after the corpus is successfully created. Format: <c>projects/{project}/locations/{location}/collections/{collection_id}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigVertexFeatureStore">
|
||
<summary>
|
||
The config for the Vertex Feature Store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigVertexFeatureStore.FeatureViewResourceName">
|
||
<summary>
|
||
The resource name of the FeatureView. Format: <c>projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigVertexVectorSearch">
|
||
<summary>
|
||
The config for the Vertex Vector Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigVertexVectorSearch.Index">
|
||
<summary>
|
||
The resource name of the Index. Format: <c>projects/{project}/locations/{location}/indexes/{index}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigVertexVectorSearch.IndexEndpoint">
|
||
<summary>
|
||
The resource name of the Index Endpoint. Format: <c>projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RagVectorDbConfigWeaviate">
|
||
<summary>
|
||
The config for the Weaviate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigWeaviate.CollectionName">
|
||
<summary>
|
||
The corresponding collection this corpus maps to. This value cannot be changed after it's set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RagVectorDbConfigWeaviate.HttpEndpoint">
|
||
<summary>
|
||
Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RawOutput">
|
||
<summary>
|
||
Raw output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RawOutput.Output">
|
||
<summary>
|
||
Output only. Raw output string.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RealtimeInputConfig">
|
||
<summary>
|
||
Configures the realtime input behavior in <c>BidiGenerateContent</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RealtimeInputConfig.ActivityHandling">
|
||
<summary>
|
||
Optional. Defines what effect activity has.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RealtimeInputConfig.AutomaticActivityDetection">
|
||
<summary>
|
||
Optional. If not set, automatic activity detection is enabled by default. If automatic voice detection is disabled, the client must send activity signals.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RealtimeInputConfig.TurnCoverage">
|
||
<summary>
|
||
Optional. Defines which input is included in the user's turn.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RealtimeInputConfig.ActivityHandlingType.ActivityHandlingUnspecified">
|
||
<summary>
|
||
If unspecified, the default behavior is `START_OF_ACTIVITY_INTERRUPTS`.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RealtimeInputConfig.ActivityHandlingType.StartOfActivityInterrupts">
|
||
<summary>
|
||
If true, start of activity will interrupt the model's response (also called "barge in"). The model's current response will be cut-off in the moment of the interruption. This is the default behavior.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RealtimeInputConfig.ActivityHandlingType.NoInterruption">
|
||
<summary>
|
||
The model's response will not be interrupted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RealtimeInputConfig.TurnCoverageType.TurnCoverageUnspecified">
|
||
<summary>
|
||
If unspecified, the default behavior is `TURN_INCLUDES_ONLY_ACTIVITY`.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RealtimeInputConfig.TurnCoverageType.TurnIncludesOnlyActivity">
|
||
<summary>
|
||
The users turn only includes activity since the last turn, excluding inactivity (e.g. silence on the audio stream). This is the default behavior.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RealtimeInputConfig.TurnCoverageType.TurnIncludesAllInput">
|
||
<summary>
|
||
The users turn includes all realtime input since the last turn, including inactivity (e.g. silence on the audio stream).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RecontextImageConfig">
|
||
<summary>
|
||
Configuration for recontextualizing an image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageConfig.BaseSteps">
|
||
<summary>
|
||
The number of sampling steps. A higher value has better image quality, while a lower value
|
||
has better latency.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RecontextImageRequest">
|
||
<summary>
|
||
Request for recontextualizing an image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageRequest.Model">
|
||
<summary>
|
||
ID of the model to use. For a list of models, see Google models
|
||
(https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageRequest.Source">
|
||
<summary>
|
||
A set of source input(s) for image recontextualization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageRequest.Config">
|
||
<summary>
|
||
Configuration for image recontextualization.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RecontextImageResponse">
|
||
<summary>
|
||
The output images response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageResponse.GeneratedImages">
|
||
<summary>
|
||
List of generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RecontextImageSource">
|
||
<summary>
|
||
A set of source input(s) for image recontextualization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageSource.Prompt">
|
||
<summary>
|
||
A text prompt for guiding the model during image recontextualization. Not supported for
|
||
Virtual Try-On.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageSource.PersonImage">
|
||
<summary>
|
||
Image of the person or subject who will be wearing the product(s).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RecontextImageSource.ProductImages">
|
||
<summary>
|
||
A list of product images.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ReferenceImage">
|
||
<summary>
|
||
Abstract class that represents a Reference image that is sent to API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReferenceImage.Image">
|
||
<summary>
|
||
Required. The reference image for the editing operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReferenceImage.ReferenceId">
|
||
<summary>
|
||
Required. The id of the reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReferenceImage.ReferenceType">
|
||
<summary>
|
||
Required. The type of the reference image. Only set by the SDK."
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReferenceImage.MaskImageConfig">
|
||
<summary>
|
||
Configuration for the mask reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReferenceImage.ControlImageConfig">
|
||
<summary>
|
||
Configuration for the control reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReferenceImage.StyleImageConfig">
|
||
<summary>
|
||
Configuration for the style reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReferenceImage.SubjectImageConfig">
|
||
<summary>
|
||
Configuration for the subject reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ReferenceType">
|
||
<summary>
|
||
Describes what the field reference contains.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.Path">
|
||
<summary>
|
||
Reference contains a GFS path or a local path.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.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.Types.ReferenceType.Inline">
|
||
<summary>
|
||
Data is included into this proto buffer.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.GetMedia">
|
||
<summary>
|
||
Data should be accessed from the current service using the operation GetMedia.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.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.Types.ReferenceType.BigstoreRef">
|
||
<summary>
|
||
Reference points to a bigstore object.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.DiffVersionResponse">
|
||
<summary>
|
||
Indicates the data is stored in diff_version_response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.DiffChecksumResponse">
|
||
<summary>
|
||
Indicates the data is stored in diff_checksums_response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.DiffDownloadResponse">
|
||
<summary>
|
||
Indicates the data is stored in diff_download_response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.DiffUploadRequest">
|
||
<summary>
|
||
Indicates the data is stored in diff_upload_request.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.DiffUploadResponse">
|
||
<summary>
|
||
Indicates the data is stored in diff_upload_response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ReferenceType.CosmoBinaryReference">
|
||
<summary>
|
||
Indicates the data is stored in cosmo_binary_reference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.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.Types.RegisterFilesRequest">
|
||
<summary>
|
||
Request for <c>RegisterFiles</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RegisterFilesRequest.Uris">
|
||
<summary>
|
||
Required. The Google Cloud Storage URIs to register. Example: <c>gs://bucket/object</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RegisterFilesResponse">
|
||
<summary>
|
||
Response for <c>RegisterFiles</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RegisterFilesResponse.Files">
|
||
<summary>
|
||
The registered files to be used when calling GenerateContent.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RelevantChunk">
|
||
<summary>
|
||
The information for a chunk relevant to a query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RelevantChunk.Chunk">
|
||
<summary>
|
||
<see cref="P:Mscc.GenerativeAI.Types.RelevantChunk.Chunk"/> associated with the query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RelevantChunk.ChunkRelevanceScore">
|
||
<summary>
|
||
<see cref="P:Mscc.GenerativeAI.Types.RelevantChunk.Chunk"/> relevance to the query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RelevantChunk.Document">
|
||
<summary>
|
||
<see cref="P:Mscc.GenerativeAI.Types.RelevantChunk.Document"/> associated with the chunk.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ReplicatedVoiceConfig">
|
||
<summary>
|
||
The configuration for the replicated voice to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReplicatedVoiceConfig.MimeType">
|
||
<summary>
|
||
Optional. The mimetype of the voice sample. The only currently supported value is <c>audio/wav</c>. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. <c>mime_type</c> will default to <c>audio/wav</c> if not set.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReplicatedVoiceConfig.VoiceSampleAudio">
|
||
<summary>
|
||
Optional. The sample of the custom voice.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RequestOptions">
|
||
<summary>
|
||
Provides options for individual API requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RequestOptions.Retry">
|
||
<summary>
|
||
Gets or sets the <see cref="P:Mscc.GenerativeAI.Types.RequestOptions.Retry"/> options for this request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RequestOptions.Timeout">
|
||
<summary>
|
||
Gets or sets the timeout for this specific request.
|
||
If set to a positive value, the request will be cancelled if it exceeds this duration.
|
||
This is achieved by linking a CancellationToken to the request.
|
||
A value of TimeSpan.Zero (the default) or a negative value means no per-request timeout will be applied beyond any default client timeout.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RequestOptions.BaseUrl">
|
||
<summary>
|
||
The base URL to use for the request.
|
||
If not set, the default base URL for the model will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RequestOptions.ApiVersion">
|
||
<summary>
|
||
Gets or sets the version of the API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RequestOptions.Proxy">
|
||
<summary>
|
||
Gets or sets the proxy to use for the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RequestOptions.Headers">
|
||
<summary>
|
||
Gets or sets the headers to use for the request.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.RequestOptions.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.RequestOptions"/> class
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.RequestOptions.#ctor(Mscc.GenerativeAI.Types.Retry,System.Nullable{System.TimeSpan},System.String,System.String,System.Net.IWebProxy)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.RequestOptions"/> class
|
||
</summary>
|
||
<param name="retry">Optional. Refer to [retry docs](https://googleapis.dev/python/google-api-core/latest/retry.html) for details.</param>
|
||
<param name="timeout">Optional. In seconds (or provide a [TimeToDeadlineTimeout](https://googleapis.dev/python/google-api-core/latest/timeout.html) object).</param>
|
||
<param name="baseUrl">Optional. The base URL to use for the request.</param>
|
||
<param name="apiVersion">Optional. The version of the API.</param>
|
||
<param name="proxy">Optional. Proxy settings to use for the request.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.RequestOptions.#ctor(Mscc.GenerativeAI.Types.HttpOptions)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.RequestOptions"/> class
|
||
</summary>
|
||
<param name="httpOptions"></param>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Retry">
|
||
<summary>
|
||
Defines the retry strategy for a request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retry.Initial">
|
||
<summary>
|
||
The initial delay before the first retry, in seconds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retry.Multiplies">
|
||
<summary>
|
||
The multiplier for the delay between retries.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retry.Maximum">
|
||
<summary>
|
||
The maximum number of retries.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retry.Timeout">
|
||
<summary>
|
||
The overall timeout for the retry logic.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retry.StatusCodes">
|
||
<summary>
|
||
The HTTP status codes that should trigger a retry.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ResponseFormat">
|
||
<summary>
|
||
Defines the format of the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ResponseFormat.Type">
|
||
<summary>
|
||
Required. Type of the response.
|
||
Can be either:
|
||
- \"text\": Format the response as text.
|
||
- \"json_object\": Format the response as a JSON object.
|
||
- \"json_schema\": Format the response as a JSON object following the given schema.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ResponseFormat.JsonSchema">
|
||
<summary>
|
||
Optional. The JSON schema to follow. Only used if type is \"json_schema\".
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ResponseFormatSchema">
|
||
<summary>
|
||
Schema for the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ResponseFormatSchema.Name">
|
||
<summary>
|
||
Required. Name of the object type represented by the schema.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ResponseFormatSchema.Description">
|
||
<summary>
|
||
Optional. Description of the object represented by the schema.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ResponseFormatSchema.Strict">
|
||
<summary>
|
||
Optional. Whether the schema validation is strict.
|
||
If true, the model will fail if the schema is not valid.
|
||
NOTE: This parameter is currently ignored.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ResponseFormatSchema.Schema">
|
||
<summary>
|
||
Optional. The JSON schema to follow.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ResponseModality.ResponseModalityUnspecified">
|
||
<summary>
|
||
Default value.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ResponseModality.ModalityUnspecified">
|
||
<summary>
|
||
Default value.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ResponseModality.Text">
|
||
<summary>
|
||
Indicates the model should return text.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ResponseModality.Image">
|
||
<summary>
|
||
Indicates the model should return images.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ResponseModality.Audio">
|
||
<summary>
|
||
Indicates the model should return audio.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Retrieval">
|
||
<summary>
|
||
Defines a retrieval tool that model can call to access external knowledge.
|
||
</summary>
|
||
<summary>
|
||
Defines a retrieval tool that model can call to access external knowledge.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retrieval.DisableAttribution">
|
||
<summary>
|
||
Optional. Deprecated. This option is no longer supported.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retrieval.ExternalApi">
|
||
<summary>
|
||
Use data source powered by external API for grounding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retrieval.VertexAiSearch">
|
||
<summary>
|
||
Set to use data source powered by Vertex AI Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Retrieval.VertexRagStore">
|
||
<summary>
|
||
Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RetrievalConfig">
|
||
<summary>
|
||
Retrieval config.
|
||
</summary>
|
||
<summary>
|
||
Retrieval config.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievalConfig.LanguageCode">
|
||
<summary>
|
||
Optional. The language code of the user. Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievalConfig.LatLng">
|
||
<summary>
|
||
Optional. The location of the user.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RetrievalMetadata">
|
||
<summary>
|
||
Metadata related to the retrieval grounding source. This is part of the <c>GroundingMetadata</c> returned when grounding is enabled.
|
||
</summary>
|
||
<summary>
|
||
Metadata related to retrieval in the grounding flow.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievalMetadata.GoogleSearchDynamicRetrievalScore">
|
||
<summary>
|
||
Optional. Score indicating how likely information from google search could help answer the prompt. The score is in the range [0, 1], where 0 is the least likely and 1 is the most likely. This score is only populated when google search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger google search.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RetrievalResource">
|
||
<summary>
|
||
The semantic retrieval resource to retrieve from.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievalResource.RagStoreName">
|
||
<summary>
|
||
Required. The name of the semantic retrieval resource to retrieve from. Example: `ragStores/my-rag-store-123`
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RetrievedContext">
|
||
<summary>
|
||
Chunk from context retrieved by the file search tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievedContext.FileSearchStore">
|
||
<summary>
|
||
Optional. Name of the <c>FileSearchStore</c> containing the document. Example: <c>fileSearchStores/123</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievedContext.Text">
|
||
<summary>
|
||
Optional. Text of the chunk.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievedContext.Title">
|
||
<summary>
|
||
Optional. Title of the document.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RetrievedContext.Uri">
|
||
<summary>
|
||
Optional. URI reference of the semantic retrieval document.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ReviewSnippet">
|
||
<summary>
|
||
Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
|
||
</summary>
|
||
<summary>
|
||
Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReviewSnippet.Id">
|
||
<summary>
|
||
The ID of the review snippet.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReviewSnippet.Uri">
|
||
<summary>
|
||
A link that corresponds to the user review on Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReviewSnippet.GoogleMapsUri">
|
||
<summary>
|
||
A link that corresponds to the user review on Google Maps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReviewSnippet.ReviewId">
|
||
<summary>
|
||
The ID of the review snippet.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ReviewSnippet.Title">
|
||
<summary>
|
||
Title of the review.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RougeMetricValue">
|
||
<summary>
|
||
Rouge metric value for an instance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RougeMetricValue.Score">
|
||
<summary>
|
||
Output only. Rouge score.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RougeSpec">
|
||
<summary>
|
||
Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RougeSpec.RougeType">
|
||
<summary>
|
||
Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RougeSpec.SplitSummaries">
|
||
<summary>
|
||
Optional. Whether to split summaries while using rougeLsum.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RougeSpec.UseStemmer">
|
||
<summary>
|
||
Optional. Whether to use stemmer to compute rouge score.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RoutingConfig">
|
||
<summary>
|
||
The configuration for routing the request to a specific model. This can be used to control
|
||
which model is used for the generation, either automatically or by specifying a model name.
|
||
This data type is not supported in Gemini API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RoutingConfig.AutoMode">
|
||
<summary>
|
||
In this mode, the model is selected automatically based on the content of the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RoutingConfig.ManualMode">
|
||
<summary>
|
||
In this mode, the model is specified manually.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.RubricGenerationSpec">
|
||
<summary>
|
||
Specification for how rubrics should be generated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RubricGenerationSpec.ModelConfig">
|
||
<summary>
|
||
Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RubricGenerationSpec.PromptTemplate">
|
||
<summary>
|
||
Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RubricGenerationSpec.RubricContentType">
|
||
<summary>
|
||
The type of rubric content to be generated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.RubricGenerationSpec.RubricTypeOntology">
|
||
<summary>
|
||
Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies <c>include_rubric_type</c> should be true, and the generated rubric types should be chosen from this ontology.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RubricGenerationSpec.RubricGenerationSpecRubricContentType.RubricContentTypeUnspecified">
|
||
<summary>
|
||
The content type to generate is not specified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RubricGenerationSpec.RubricGenerationSpecRubricContentType.Property">
|
||
<summary>
|
||
Generate rubrics based on properties.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RubricGenerationSpec.RubricGenerationSpecRubricContentType.NlQuestionAnswer">
|
||
<summary>
|
||
Generate rubrics in an NL question answer format.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.RubricGenerationSpec.RubricGenerationSpecRubricContentType.PythonCodeAssertion">
|
||
<summary>
|
||
Generate rubrics in a unit test format.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SafetyFeedback">
|
||
<summary>
|
||
Safety feedback for an entire request. This field is populated if content in the input and/or response is blocked due to safety settings. SafetyFeedback may not exist for every HarmCategory. Each SafetyFeedback will return the safety settings used by the request as well as the lowest HarmProbability that should be allowed in order to return a result.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyFeedback.Rating">
|
||
<summary>
|
||
Safety rating evaluated from content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyFeedback.Setting">
|
||
<summary>
|
||
Safety settings applied to the request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SafetyFilterLevel">
|
||
<summary>
|
||
Enum that controls the safety filter level for objectionable content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyFilterLevel.BlockLowAndAbove">
|
||
<summary>
|
||
Content with NEGLIGIBLE will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyFilterLevel.BlockMediumAndAbove">
|
||
<summary>
|
||
Content with NEGLIGIBLE and LOW will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyFilterLevel.BlockOnlyHigh">
|
||
<summary>
|
||
Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyFilterLevel.BlockNone">
|
||
<summary>
|
||
All content will be allowed.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SafetyRating">
|
||
<summary>
|
||
A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
|
||
</summary>
|
||
<summary>
|
||
A safety rating for a piece of content. The safety rating contains the harm category and the
|
||
harm probability level.
|
||
Ref: https://ai.google.dev/api/rest/v1beta/SafetyRating
|
||
</summary>
|
||
<summary>
|
||
Safety rating for a piece of content. The safety rating contains the category of harm and the harm probability level in that category for a piece of content. Content is classified for safety across a number of harm categories and the probability of the harm classification is included here.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyRating.OverwrittenThreshold">
|
||
<summary>
|
||
Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyRating.ProbabilityScore">
|
||
<summary>
|
||
Output only. The probability score of harm for this category.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyRating.Severity">
|
||
<summary>
|
||
Output only. The severity of harm for this category.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyRating.SeverityScore">
|
||
<summary>
|
||
Output only. The severity score of harm for this category.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyRating.OverwrittenThresholdType.HarmBlockThresholdUnspecified">
|
||
<summary>
|
||
The harm block threshold is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyRating.OverwrittenThresholdType.BlockLowAndAbove">
|
||
<summary>
|
||
Block content with a low harm probability or higher.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyRating.OverwrittenThresholdType.BlockMediumAndAbove">
|
||
<summary>
|
||
Block content with a medium harm probability or higher.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyRating.OverwrittenThresholdType.BlockOnlyHigh">
|
||
<summary>
|
||
Block content with a high harm probability.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyRating.OverwrittenThresholdType.BlockNone">
|
||
<summary>
|
||
Do not block any content, regardless of its harm probability.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SafetyRating.OverwrittenThresholdType.Off">
|
||
<summary>
|
||
Turn off the safety filter entirely.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyRating.Blocked">
|
||
<summary>
|
||
Was this content blocked because of this rating?
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyRating.Category">
|
||
<summary>
|
||
Required. The category for this rating.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetyRating.Probability">
|
||
<summary>
|
||
Required. The probability of harm for this content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SafetySetting">
|
||
<summary>
|
||
A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
|
||
</summary>
|
||
<summary>
|
||
A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm
|
||
category and a threshold for that category.
|
||
</summary>
|
||
<remarks>
|
||
Represents a safety setting that can be used to control the model's behavior.
|
||
It instructs the model to avoid certain responses given safety measurements based on category.
|
||
Ref: https://ai.google.dev/api/rest/v1beta/SafetySetting
|
||
</remarks>
|
||
<summary>
|
||
Safety setting, affecting the safety-blocking behavior. Passing a safety setting for a category changes the allowed probability that content is blocked.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetySetting.Method">
|
||
<summary>
|
||
Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetySetting.Category">
|
||
<summary>
|
||
Required. The category for this setting.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SafetySetting.Threshold">
|
||
<summary>
|
||
Required. Controls the probability threshold at which harm is blocked.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SampledShapleyAttribution">
|
||
<summary>
|
||
An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SampledShapleyAttribution.PathCount">
|
||
<summary>
|
||
Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SavedQuery">
|
||
<summary>
|
||
A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.AnnotationFilter">
|
||
<summary>
|
||
Output only. Filters on the Annotations in the dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.AnnotationSpecCount">
|
||
<summary>
|
||
Output only. Number of AnnotationSpecs in the context of the SavedQuery.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.CreateTime">
|
||
<summary>
|
||
Output only. Timestamp when this SavedQuery was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.DisplayName">
|
||
<summary>
|
||
Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.Etag">
|
||
<summary>
|
||
Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.Metadata">
|
||
<summary>
|
||
Some additional information about the SavedQuery.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.Name">
|
||
<summary>
|
||
Output only. Resource name of the SavedQuery.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.ProblemType">
|
||
<summary>
|
||
Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.SupportAutomlTraining">
|
||
<summary>
|
||
Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SavedQuery.UpdateTime">
|
||
<summary>
|
||
Output only. Timestamp when SavedQuery was last updated.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Scheduling">
|
||
<summary>
|
||
All parameters related to queuing and scheduling of custom jobs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Scheduling.DisableRetries">
|
||
<summary>
|
||
Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides <c>Scheduling.restart_job_on_worker_restart</c> to false.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Scheduling.MaxWaitDuration">
|
||
<summary>
|
||
Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Scheduling.RestartJobOnWorkerRestart">
|
||
<summary>
|
||
Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Scheduling.Strategy">
|
||
<summary>
|
||
Optional. This determines which type of scheduling strategy to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Scheduling.Timeout">
|
||
<summary>
|
||
Optional. The maximum job running time. The default is 7 days.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Scheduling.StrategyType.StrategyUnspecified">
|
||
<summary>
|
||
Strategy will default to STANDARD.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Scheduling.StrategyType.OnDemand">
|
||
<summary>
|
||
Deprecated. Regular on-demand provisioning strategy.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Scheduling.StrategyType.LowCost">
|
||
<summary>
|
||
Deprecated. Low cost by making potential use of spot resources.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Scheduling.StrategyType.Standard">
|
||
<summary>
|
||
Standard provisioning strategy uses regular on-demand resources.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Scheduling.StrategyType.Spot">
|
||
<summary>
|
||
Spot provisioning strategy uses spot resources.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Scheduling.StrategyType.FlexStart">
|
||
<summary>
|
||
Flex Start strategy uses DWS to queue for resources.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SchedulingType">
|
||
<summary>
|
||
Specifies how the response should be scheduled in the conversation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SchedulingType.SchedulingUnspecified">
|
||
<summary>
|
||
This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SchedulingType.Silent">
|
||
<summary>
|
||
Only add the result to the conversation context, do not interrupt or trigger generation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SchedulingType.When_Idle">
|
||
<summary>
|
||
Add the result to the conversation context, and prompt to generate output without interrupting ongoing generation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SchedulingType.Interrupt">
|
||
<summary>
|
||
Add the result to the conversation context, interrupt ongoing generation and prompt to generate output.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Schema">
|
||
<summary>
|
||
Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object).
|
||
</summary>
|
||
<summary>
|
||
The <c>Schema</c> object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.AdditionalProperties">
|
||
<summary>
|
||
Optional. If <c>type</c> is <c>OBJECT</c>, specifies how to handle properties not defined in <c>properties</c>. If it is a boolean <c>false</c>, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Defs">
|
||
<summary>
|
||
Optional. <c>defs</c> provides a map of schema definitions that can be reused by <c>ref</c> elsewhere in the schema. Only allowed at root level of the schema.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Ref">
|
||
<summary>
|
||
Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in <c>defs</c>. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.FromJsonElement(System.Text.Json.JsonElement)">
|
||
<summary>
|
||
Converts a JsonElement representing a JSON Schema to a Schema object.
|
||
</summary>
|
||
<param name="jsonElement">The JsonElement containing the JSON Schema</param>
|
||
<returns>A Schema object representing the JSON Schema</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.FromString(System.String)">
|
||
<summary>
|
||
Creates a Schema from a string. Supports either:
|
||
- A JSON object string representing a JSON Schema, or
|
||
- A simple OpenAPI type name (string, number, integer, boolean, array, object, null).
|
||
If the string is a JSON string containing a nested JSON object, it will be parsed recursively.
|
||
</summary>
|
||
<param name="value">JSON schema text or a simple type name</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when value is null</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when value is whitespace-only or cannot be parsed into a Schema</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.FromObject(System.Object)">
|
||
<summary>
|
||
Builds a Schema from a .NET object using Json.Schema generation, then maps it into the internal Schema model.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.FromType``1">
|
||
<summary>
|
||
Builds a Schema from a .NET type using Json.Schema generation, then maps it into the internal Schema model.
|
||
</summary>
|
||
<typeparam name="T">Any type.</typeparam>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.FromType``1(System.String)">
|
||
<summary>
|
||
Builds a Schema from a .NET type using Json.Schema generation, then maps it into the internal Schema model.
|
||
</summary>
|
||
<param name="filename">The file name of the assembly's XML comment file.</param>
|
||
<typeparam name="T">Any type in the assembly.</typeparam>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.FromType(System.Type)">
|
||
<summary>
|
||
Builds a Schema from a .NET type using Json.Schema generation, then maps it into the internal Schema model.
|
||
</summary>
|
||
<param name="type">The type to generate.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.FromType(System.Type,Json.Schema.Generation.SchemaGeneratorConfiguration)">
|
||
<summary>
|
||
Builds a Schema from a .NET type using Json.Schema generation, then maps it into the internal Schema model.
|
||
</summary>
|
||
<param name="type">The type to generate.</param>
|
||
<param name="config">The <see cref="T:Json.Schema.Generation.SchemaGeneratorConfiguration"/> to use.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.BuildParametersSchemaFromDelegate(System.Delegate)">
|
||
<summary>
|
||
Builds a parameters <see cref="T:Mscc.GenerativeAI.Types.Schema"/> from a delegate's signature.
|
||
Skips framework parameters such as <see cref="T:System.Threading.CancellationToken"/> that should not be exposed to the model.
|
||
</summary>
|
||
<param name="callback">The delegate whose parameters will be used to construct the schema.</param>
|
||
<returns>
|
||
A <see cref="T:Mscc.GenerativeAI.Types.Schema"/> representing the parameters of the delegate as an object with named properties,
|
||
or <c>null</c> if there are no user-exposed parameters.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Schema.BuildResponseSchemaFromDelegate(System.Delegate)">
|
||
<summary>
|
||
Builds a response <see cref="T:Mscc.GenerativeAI.Types.Schema"/> from a delegate's return type.
|
||
Returns <c>null</c> for <c>void</c>, <c>Task</c>, or <c>ValueTask</c> without a result.
|
||
</summary>
|
||
<param name="callback">The delegate whose return type will be used to generate the schema.</param>
|
||
<returns>
|
||
A <see cref="T:Mscc.GenerativeAI.Types.Schema"/> representing the return type of the delegate,
|
||
or <c>null</c> if the return type is <c>void</c>, <c>Task</c>, or <c>ValueTask</c> without a result.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.AnyOf">
|
||
<summary>
|
||
Optional. The value should be validated against any (one or more) of the subschemas in the list.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Default">
|
||
<summary>
|
||
Optional. Default value of the field. Per JSON Schema, this field is intended for documentation generators and doesn't affect validation. Thus it's included here and ignored so that developers who send schemas with a <c>default</c> field don't get unknown-field errors.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Description">
|
||
<summary>
|
||
Optional. A brief description of the parameter. This could contain examples of use. Parameter description may be formatted as Markdown.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Enum">
|
||
<summary>
|
||
Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Example">
|
||
<summary>
|
||
Optional. Example of the object. Will only populated when the object is the root.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Format">
|
||
<summary>
|
||
Optional. The format of the data. Any value is allowed, but most do not trigger any special functionality.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Items">
|
||
<summary>
|
||
Optional. Schema of the elements of Type.ARRAY.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.MaxItems">
|
||
<summary>
|
||
Optional. Maximum number of the elements for Type.ARRAY.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.MaxLength">
|
||
<summary>
|
||
Optional. Maximum length of the Type.STRING
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.MaxProperties">
|
||
<summary>
|
||
Optional. Maximum number of the properties for Type.OBJECT.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Maximum">
|
||
<summary>
|
||
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.MinItems">
|
||
<summary>
|
||
Optional. Minimum number of the elements for Type.ARRAY.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.MinLength">
|
||
<summary>
|
||
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.MinProperties">
|
||
<summary>
|
||
Optional. Minimum number of the properties for Type.OBJECT.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Minimum">
|
||
<summary>
|
||
Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Nullable">
|
||
<summary>
|
||
Optional. Indicates if the value may be null.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Pattern">
|
||
<summary>
|
||
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Properties">
|
||
<summary>
|
||
Optional. Properties of Type.OBJECT.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.PropertyOrdering">
|
||
<summary>
|
||
Optional. The order of the properties. Not a standard field in open api spec. Used to determine the order of the properties in the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Required">
|
||
<summary>
|
||
Optional. Required properties of Type.OBJECT.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Title">
|
||
<summary>
|
||
Optional. The title of the schema.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Schema.Type">
|
||
<summary>
|
||
Required. Data type.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SdkListModelsResponse">
|
||
<summary>
|
||
Response for list models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SdkListModelsResponse.Data">
|
||
<summary>
|
||
Output only. A list of the requested embeddings.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SdkListModelsResponse.Object">
|
||
<summary>
|
||
Output only. Always "list", required by the SDK.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SearchEntryPoint">
|
||
<summary>
|
||
An entry point for displaying Google Search results. A <c>SearchEntryPoint</c> is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.
|
||
</summary>
|
||
<summary>
|
||
Google search entry point.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SearchEntryPoint.RenderedContent">
|
||
<summary>
|
||
Optional. Web content snippet that can be embedded in a web page or an app webview.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SearchEntryPoint.SdkBlob">
|
||
<summary>
|
||
Optional. Base64 encoded JSON representing array of tuple.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SearchTypes">
|
||
<summary>
|
||
Different types of search that can be enabled on the GoogleSearch tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SearchTypes.ImageSearch">
|
||
<summary>
|
||
Optional. Setting this field enables image search. Image bytes are returned.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SearchTypes.WebSearch">
|
||
<summary>
|
||
Optional. Setting this field enables web search. Only text results are returned.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Segment">
|
||
<summary>
|
||
A segment of the content.
|
||
</summary>
|
||
<summary>
|
||
Segment of the content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Segment.EndIndex">
|
||
<summary>
|
||
End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Segment.PartIndex">
|
||
<summary>
|
||
The index of a Part object within its parent Content object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Segment.StartIndex">
|
||
<summary>
|
||
Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Segment.Text">
|
||
<summary>
|
||
The text corresponding to the segment from the response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SemanticRetrieverChunk">
|
||
<summary>
|
||
Identifier for a <c>Chunk</c> retrieved via Semantic Retriever specified in the <c>GenerateAnswerRequest</c> using <c>SemanticRetrieverConfig</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SemanticRetrieverChunk.Chunk">
|
||
<summary>
|
||
Output only. Name of the <c>Chunk</c> containing the attributed text. Example: <c>corpora/123/documents/abc/chunks/xyz</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SemanticRetrieverChunk.Source">
|
||
<summary>
|
||
Output only. Name of the source matching the request's <c>SemanticRetrieverConfig.source</c>. Example: <c>corpora/123</c> or <c>corpora/123/documents/abc</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SemanticRetrieverConfig">
|
||
<summary>
|
||
Configuration for retrieving grounding content from a <c>Corpus</c> or <c>Document</c> created using the Semantic Retriever API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SemanticRetrieverConfig.MaxChunksCount">
|
||
<summary>
|
||
Optional. Maximum number of relevant <c>Chunk</c>s to retrieve.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SemanticRetrieverConfig.MetadataFilters">
|
||
<summary>
|
||
Optional. Filters for selecting <c>Document</c>s and/or <c>Chunk</c>s from the resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SemanticRetrieverConfig.MinimumRelevanceScore">
|
||
<summary>
|
||
Optional. Minimum relevance score for retrieved relevant <c>Chunk</c>s.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SemanticRetrieverConfig.Query">
|
||
<summary>
|
||
Required. Query to use for matching <c>Chunk</c>s in the given resource by similarity.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SemanticRetrieverConfig.Source">
|
||
<summary>
|
||
Required. Name of the resource for retrieval. Example: <c>corpora/123</c> or <c>corpora/123/documents/abc</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SessionResumptionConfig">
|
||
<summary>
|
||
Session resumption configuration. This message is included in the session configuration as <c>BidiGenerateContentSetup.session_resumption</c>. If configured, the server will send <c>SessionResumptionUpdate</c> messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SessionResumptionConfig.Handle">
|
||
<summary>
|
||
The handle of a previous session. If not present then a new session is created. Session handles come from <c>SessionResumptionUpdate.token</c> values in previous connections.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SharePointSources">
|
||
<summary>
|
||
The SharePointSources to pass to ImportRagFiles.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSources.Sources">
|
||
<summary>
|
||
The SharePoint sources.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource">
|
||
<summary>
|
||
An individual SharePointSource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.ClientId">
|
||
<summary>
|
||
The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.ClientSecret">
|
||
<summary>
|
||
The application secret for the app registered in Azure.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.DriveId">
|
||
<summary>
|
||
The ID of the drive to download from.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.DriveName">
|
||
<summary>
|
||
The name of the drive to download from.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.FileId">
|
||
<summary>
|
||
Output only. The SharePoint file id. Output only.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.SharepointFolderId">
|
||
<summary>
|
||
The ID of the SharePoint folder to download from.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.SharepointFolderPath">
|
||
<summary>
|
||
The path of the SharePoint folder to download from.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.SharepointSiteName">
|
||
<summary>
|
||
The name of the SharePoint site to download from. This can be the site name or the site id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SharePointSourcesSharePointSource.TenantId">
|
||
<summary>
|
||
Unique identifier of the Azure Active Directory Instance.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SlackSource">
|
||
<summary>
|
||
The Slack source for the ImportRagFilesRequest.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SlackSource.Channels">
|
||
<summary>
|
||
Required. The Slack channels.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SlackSourceSlackChannels">
|
||
<summary>
|
||
SlackChannels contains the Slack channels and corresponding access token.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SlackSourceSlackChannels.ApiKeyConfig">
|
||
<summary>
|
||
Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SlackSourceSlackChannels.Channels">
|
||
<summary>
|
||
Required. The Slack channel IDs.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SlackSourceSlackChannelsSlackChannel">
|
||
<summary>
|
||
SlackChannel contains the Slack channel ID and the time range to import.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SlackSourceSlackChannelsSlackChannel.ChannelId">
|
||
<summary>
|
||
Required. The Slack channel ID.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SlackSourceSlackChannelsSlackChannel.EndTime">
|
||
<summary>
|
||
Optional. The ending timestamp for messages to import.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SlackSourceSlackChannelsSlackChannel.StartTime">
|
||
<summary>
|
||
Optional. The starting timestamp for messages to import.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SlidingWindow">
|
||
<summary>
|
||
The SlidingWindow method operates by discarding content at the beginning of the context window. The resulting context will always begin at the start of a USER role turn. System instructions and any <c>BidiGenerateContentSetup.prefix_turns</c> will always remain at the beginning of the result.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SlidingWindow.TargetTokens">
|
||
<summary>
|
||
The target number of tokens to keep. The default value is trigger_tokens/2. Discarding parts of the context window causes a temporary latency increase so this value should be calibrated to avoid frequent compression operations.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SmoothGradConfig">
|
||
<summary>
|
||
Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SmoothGradConfig.FeatureNoiseSigma">
|
||
<summary>
|
||
This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SmoothGradConfig.NoiseSigma">
|
||
<summary>
|
||
This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SmoothGradConfig.NoisySampleCount">
|
||
<summary>
|
||
The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Source.SourceUnspecified">
|
||
<summary>
|
||
Used if source is not specified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Source.Uploaded">
|
||
<summary>
|
||
Indicates the file is uploaded by the user.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Source.Generated">
|
||
<summary>
|
||
Indicates the file is generated by Google.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.Source.Registered">
|
||
<summary>
|
||
Indicates the file is a registered, i.e. a Google Cloud Storage file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SpeakerVoiceConfig">
|
||
<summary>
|
||
Configuration for a single speaker in a multi-speaker setup.
|
||
</summary>
|
||
<summary>
|
||
The configuration for a single speaker in a multi speaker setup.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SpeakerVoiceConfig.Speaker">
|
||
<summary>
|
||
Required. The name of the speaker to use. Should be the same as in the prompt.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SpeakerVoiceConfig.VoiceConfig">
|
||
<summary>
|
||
Required. The configuration for the voice to use.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SpeechConfig">
|
||
<summary>
|
||
Configuration for speech generation.
|
||
</summary>
|
||
<summary>
|
||
Config for speech generation and transcription.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SpeechConfig.LanguageCode">
|
||
<summary>
|
||
Optional. The IETF [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language code that the user configured the app to use. Used for speech recognition and synthesis. Valid values are: <c>de-DE</c>, <c>en-AU</c>, <c>en-GB</c>, <c>en-IN</c>, <c>en-US</c>, <c>es-US</c>, <c>fr-FR</c>, <c>hi-IN</c>, <c>pt-BR</c>, <c>ar-XA</c>, <c>es-ES</c>, <c>fr-CA</c>, <c>id-ID</c>, <c>it-IT</c>, <c>ja-JP</c>, <c>tr-TR</c>, <c>vi-VN</c>, <c>bn-IN</c>, <c>gu-IN</c>, <c>kn-IN</c>, <c>ml-IN</c>, <c>mr-IN</c>, <c>ta-IN</c>, <c>te-IN</c>, <c>nl-NL</c>, <c>ko-KR</c>, <c>cmn-CN</c>, <c>pl-PL</c>, <c>ru-RU</c>, and <c>th-TH</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SpeechConfig.MultiSpeakerVoiceConfig">
|
||
<summary>
|
||
Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voice_config field.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SpeechConfig.VoiceConfig">
|
||
<summary>
|
||
The configuration in case of single-voice output.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateUnspecified">
|
||
<summary>
|
||
The default value. This value is used if the state is omitted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StatePending">
|
||
<summary>
|
||
Some `Chunks` of the `Document` are being processed (embedding and vector storage).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateActive">
|
||
<summary>
|
||
All `Chunks` of the `Document` is processed and available for querying.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateFailed">
|
||
<summary>
|
||
Some `Chunks` of the `Document` failed processing.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.BatchStateUnspecified">
|
||
<summary>
|
||
The batch state is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.BatchStatePending">
|
||
<summary>
|
||
The service is preparing to run the batch.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.BatchStateRunning">
|
||
<summary>
|
||
The batch is in progress.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.BatchStateSucceeded">
|
||
<summary>
|
||
The batch completed successfully.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.BatchStateFailed">
|
||
<summary>
|
||
The batch failed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.BatchStateCancelled">
|
||
<summary>
|
||
The batch has been cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.BatchStateExpired">
|
||
<summary>
|
||
The batch has expired.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Processing">
|
||
<summary>
|
||
File is being processed and cannot be used for inference yet.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Active">
|
||
<summary>
|
||
File is processed and available for inference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Failed">
|
||
<summary>
|
||
File failed processing.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Generating">
|
||
<summary>
|
||
Being generated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Generated">
|
||
<summary>
|
||
Generated and is ready for download.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Creating">
|
||
<summary>
|
||
The model is being created.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Pending">
|
||
<summary>
|
||
A state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Live">
|
||
<summary>
|
||
A state indicating that the Artifact should exist, unless something external to the system deletes it.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateUnspecified">
|
||
<summary>
|
||
The job state is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateQueued">
|
||
<summary>
|
||
The job has been just created or resumed and processing has not yet begun.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStatePending">
|
||
<summary>
|
||
The service is preparing to run the job.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateRunning">
|
||
<summary>
|
||
The job is in progress.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateSucceeded">
|
||
<summary>
|
||
The job completed successfully.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateFailed">
|
||
<summary>
|
||
The job failed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateCancelling">
|
||
<summary>
|
||
The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateCancelled">
|
||
<summary>
|
||
The job has been cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStatePaused">
|
||
<summary>
|
||
The job has been stopped, and can be resumed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateExpired">
|
||
<summary>
|
||
The job has expired.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStateUpdating">
|
||
<summary>
|
||
The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.JobStatePartiallySucceeded">
|
||
<summary>
|
||
The job is partially succeeded, some results may be missing due to errors.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Unknown">
|
||
<summary>
|
||
This state is not supposed to happen.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Initialized">
|
||
<summary>
|
||
RagCorpus resource entry is initialized, but hasn't done validation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Error">
|
||
<summary>
|
||
RagCorpus is in a problematic situation. See `error_message` field for details.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Running">
|
||
<summary>
|
||
The evaluation run is running.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Succeeded">
|
||
<summary>
|
||
The evaluation run has succeeded.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Cancelled">
|
||
<summary>
|
||
The evaluation run has been cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Inference">
|
||
<summary>
|
||
The evaluation run is performing inference.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.GeneratingRubrics">
|
||
<summary>
|
||
The evaluation run is performing rubric generation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.New">
|
||
<summary>
|
||
The Execution is new
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Complete">
|
||
<summary>
|
||
The Execution has finished running
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Cached">
|
||
<summary>
|
||
The Execution completed through Cache hit.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Stable">
|
||
<summary>
|
||
State when the featureOnlineStore configuration is not being updated and the fields reflect the current configuration of the featureOnlineStore. The featureOnlineStore is usable in this state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Updating">
|
||
<summary>
|
||
The state of the featureOnlineStore configuration when it is being updated. During an update, the fields reflect either the original configuration or the updated configuration of the featureOnlineStore. The featureOnlineStore is still usable in this state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Default">
|
||
<summary>
|
||
The default behavior of whether to enable the monitoring. EntityType-level config: disabled. Feature-level config: inherited from the configuration of EntityType this Feature belongs to.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Enabled">
|
||
<summary>
|
||
Explicitly enables import features analysis. EntityType-level config: by default enables import features analysis for all Features under it. Feature-level config: enables import features analysis regardless of the EntityType-level config.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Disabled">
|
||
<summary>
|
||
Explicitly disables import features analysis. EntityType-level config: by default disables import features analysis for all Features under it. Feature-level config: disables import features analysis regardless of the EntityType-level config.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Requested">
|
||
<summary>
|
||
Indicates that a specific NasTrial has been requested, but it has not yet been suggested by the service.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Stopping">
|
||
<summary>
|
||
Indicates that the NasTrial should stop according to the service.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Infeasible">
|
||
<summary>
|
||
Indicates that the NasTrial should not be attempted again. The service will set a NasTrial to INFEASIBLE when it's done but missing the final_measurement.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PscAutomationStateUnspecified">
|
||
<summary>
|
||
Should not be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PscAutomationStateSuccessful">
|
||
<summary>
|
||
The PSC service automation is successful.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PscAutomationStateFailed">
|
||
<summary>
|
||
The PSC service automation has failed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Provisioning">
|
||
<summary>
|
||
The PROVISIONING state indicates the persistent resources is being created.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Rebooting">
|
||
<summary>
|
||
The REBOOTING state indicates the persistent resource is being rebooted (PR is not available right now but is expected to be ready again later).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStateUnspecified">
|
||
<summary>
|
||
The pipeline state is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStateQueued">
|
||
<summary>
|
||
The pipeline has been created or resumed, and processing has not yet begun.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStatePending">
|
||
<summary>
|
||
The service is preparing to run the pipeline.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStateRunning">
|
||
<summary>
|
||
The pipeline is in progress.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStateSucceeded">
|
||
<summary>
|
||
The pipeline completed successfully.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStateFailed">
|
||
<summary>
|
||
The pipeline failed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStateCancelling">
|
||
<summary>
|
||
The pipeline is being cancelled. From this state, the pipeline may only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStateCancelled">
|
||
<summary>
|
||
The pipeline has been cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.PipelineStatePaused">
|
||
<summary>
|
||
The pipeline has been stopped, and can be resumed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.CancelPending">
|
||
<summary>
|
||
Specifies Task cancel is in pending state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Cancelling">
|
||
<summary>
|
||
Specifies task is being cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Skipped">
|
||
<summary>
|
||
Specifies task was skipped due to cache hit.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.NotTriggered">
|
||
<summary>
|
||
Specifies that the task was not triggered because the task's trigger policy is not satisfied. The trigger policy is specified in the `condition` field of PipelineJob.pipeline_spec.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateProvisioning">
|
||
<summary>
|
||
Runtime resources are being allocated for the sandbox environment.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateRunning">
|
||
<summary>
|
||
Sandbox runtime is ready for serving.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateDeprovisioning">
|
||
<summary>
|
||
Sandbox runtime is halted, performing tear down tasks.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateTerminated">
|
||
<summary>
|
||
Sandbox has terminated with underlying runtime failure.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.StateDeleted">
|
||
<summary>
|
||
Sandbox runtime has been deleted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Paused">
|
||
<summary>
|
||
The schedule is paused. No new runs will be created until the schedule is resumed. Already started runs will be allowed to complete.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Completed">
|
||
<summary>
|
||
The Schedule is completed. No new runs will be scheduled. Already started runs will be allowed to complete. Schedules in completed state cannot be paused or resumed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.State.Inactive">
|
||
<summary>
|
||
The study is stopped due to an internal error.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Status">
|
||
<summary>
|
||
The <c>Status</c> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each <c>Status</c> message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
|
||
</summary>
|
||
<summary>
|
||
The <see cref="T:Mscc.GenerativeAI.Types.Status"/> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each <see cref="T:Mscc.GenerativeAI.Types.Status"/> message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Status.Code">
|
||
<summary>
|
||
The status code, which should be an enum value of google.rpc.Code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Status.Details">
|
||
<summary>
|
||
A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Status.Message">
|
||
<summary>
|
||
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.StoredContentsExample">
|
||
<summary>
|
||
A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StoredContentsExample.ContentsExample">
|
||
<summary>
|
||
Required. The example to be used with GenerateContent.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StoredContentsExample.SearchKey">
|
||
<summary>
|
||
Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from <c>contents_example.contents</c> using the method provided by <c>search_key_generation_method</c>. The generated search key will be included in retrieved examples.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StoredContentsExample.SearchKeyGenerationMethod">
|
||
<summary>
|
||
Optional. The method used to generate the search key from <c>contents_example.contents</c>. This is ignored when uploading an example if <c>search_key</c> is provided.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.StoredContentsExampleSearchKeyGenerationMethod">
|
||
<summary>
|
||
Options for generating the search key from the conversation history.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StoredContentsExampleSearchKeyGenerationMethod.LastEntry">
|
||
<summary>
|
||
Use only the last entry of the conversation history (<c>contents_example.contents</c>) as the search key.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.StoredContentsExampleSearchKeyGenerationMethodLastEntry">
|
||
<summary>
|
||
Configuration for using only the last entry of the conversation history as the search key.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.StreamableHttpTransport">
|
||
<summary>
|
||
A transport that can stream HTTP requests and responses. Next ID: 6
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StreamableHttpTransport.Headers">
|
||
<summary>
|
||
Optional: Fields for authentication headers, timeouts, etc., if needed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StreamableHttpTransport.SseReadTimeout">
|
||
<summary>
|
||
Timeout for SSE read operations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StreamableHttpTransport.TerminateOnClose">
|
||
<summary>
|
||
Whether to close the client session when the transport closes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StreamableHttpTransport.Timeout">
|
||
<summary>
|
||
HTTP timeout for regular operations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StreamableHttpTransport.Url">
|
||
<summary>
|
||
The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.StreamOptions">
|
||
<summary>
|
||
Options for streaming requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StreamOptions.IncludeUsage">
|
||
<summary>
|
||
Optional. If set, include usage statistics in the response.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.StringList">
|
||
<summary>
|
||
User provided string values assigned to a single metadata key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StringList.Values">
|
||
<summary>
|
||
The string values of the metadata to store.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.StyleImageConfig">
|
||
<summary>
|
||
Configuration for a Style reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.StyleImageConfig.StyleDescription">
|
||
<summary>
|
||
A text description of the style to use for the generated image.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SubjectImageConfig">
|
||
<summary>
|
||
Configuration for a Subject reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SubjectImageConfig.SubjectType">
|
||
<summary>
|
||
The subject type of a subject reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SubjectImageConfig.SubjectDescription">
|
||
<summary>
|
||
Subject description for the image.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SubjectReferenceType">
|
||
<summary>
|
||
Enum representing the subject type of a subject reference image.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SubjectReferenceType.SubjectTypeDefault">
|
||
<summary>
|
||
Default subject type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SubjectReferenceType.SubjectTypePerson">
|
||
<summary>
|
||
Person subject type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SubjectReferenceType.SubjectTypeAnimal">
|
||
<summary>
|
||
Animal subject type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.SubjectReferenceType.SubjectTypeProduct">
|
||
<summary>
|
||
Product subject type.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SupervisedHyperParameters">
|
||
<summary>
|
||
Hyperparameters for SFT.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedHyperParameters.AdapterSize">
|
||
<summary>
|
||
Optional. Adapter size for tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedHyperParameters.BatchSize">
|
||
<summary>
|
||
Optional. Batch size for tuning. This feature is only available for open source models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedHyperParameters.EpochCount">
|
||
<summary>
|
||
Optional. Number of complete passes the model makes over the entire training dataset during training.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedHyperParameters.LearningRate">
|
||
<summary>
|
||
Optional. Learning rate for tuning. Mutually exclusive with <c>learning_rate_multiplier</c>. This feature is only available for open source models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedHyperParameters.LearningRateMultiplier">
|
||
<summary>
|
||
Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with <c>learning_rate</c>. This feature is only available for 1P models.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution">
|
||
<summary>
|
||
Dataset distribution for Supervised Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.BillableSum">
|
||
<summary>
|
||
Output only. Sum of a given population of values that are billable.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.Buckets">
|
||
<summary>
|
||
Output only. Defines the histogram bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.Max">
|
||
<summary>
|
||
Output only. The maximum of the population values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.Mean">
|
||
<summary>
|
||
Output only. The arithmetic mean of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.Median">
|
||
<summary>
|
||
Output only. The median of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.Min">
|
||
<summary>
|
||
Output only. The minimum of the population values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.P5">
|
||
<summary>
|
||
Output only. The 5th percentile of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.P95">
|
||
<summary>
|
||
Output only. The 95th percentile of the values in the population.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistribution.Sum">
|
||
<summary>
|
||
Output only. Sum of a given population of values.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistributionDatasetBucket">
|
||
<summary>
|
||
Dataset bucket used to create a histogram for the distribution given a population of values.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistributionDatasetBucket.Count">
|
||
<summary>
|
||
Output only. Number of values in the bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistributionDatasetBucket.Left">
|
||
<summary>
|
||
Output only. Left bound of the bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDatasetDistributionDatasetBucket.Right">
|
||
<summary>
|
||
Output only. Right bound of the bucket.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SupervisedTuningDataStats">
|
||
<summary>
|
||
Tuning data statistics for Supervised Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.DroppedExampleReasons">
|
||
<summary>
|
||
Output only. For each index in <c>truncated_example_indices</c>, the user-facing reason why the example was dropped.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.TotalBillableCharacterCount">
|
||
<summary>
|
||
Output only. Number of billable characters in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.TotalBillableTokenCount">
|
||
<summary>
|
||
Output only. Number of billable tokens in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.TotalTruncatedExampleCount">
|
||
<summary>
|
||
Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.TotalTuningCharacterCount">
|
||
<summary>
|
||
Output only. Number of tuning characters in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.TruncatedExampleIndices">
|
||
<summary>
|
||
Output only. A partial sample of the indices (starting from 1) of the dropped examples.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.TuningDatasetExampleCount">
|
||
<summary>
|
||
Output only. Number of examples in the tuning dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.TuningStepCount">
|
||
<summary>
|
||
Output only. Number of tuning steps for this Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.UserDatasetExamples">
|
||
<summary>
|
||
Output only. Sample user messages in the training dataset uri.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.UserInputTokenDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the user input tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.UserMessagePerExampleDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the messages per example.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningDataStats.UserOutputTokenDistribution">
|
||
<summary>
|
||
Output only. Dataset distributions for the user output tokens.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.SupervisedTuningSpec">
|
||
<summary>
|
||
Tuning Spec for Supervised Tuning for first party models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningSpec.EvaluationConfig">
|
||
<summary>
|
||
Optional. Evaluation Config for Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningSpec.ExportLastCheckpointOnly">
|
||
<summary>
|
||
Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningSpec.HyperParameters">
|
||
<summary>
|
||
Optional. Hyperparameters for SFT.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningSpec.TrainingDatasetUri">
|
||
<summary>
|
||
Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningSpec.TuningMode">
|
||
<summary>
|
||
Tuning mode.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.SupervisedTuningSpec.ValidationDatasetUri">
|
||
<summary>
|
||
Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.TaskTypeUnspecified">
|
||
<summary>
|
||
Unset value, which will default to one of the other enum values.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.RetrievalQuery">
|
||
<summary>
|
||
Specifies the given text is a query in a search/retrieval setting.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.RetrievalDocument">
|
||
<summary>
|
||
Specifies the given text is a document from the corpus being searched.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.SemanticSimilarity">
|
||
<summary>
|
||
Specifies the given text will be used for STS.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.Classification">
|
||
<summary>
|
||
Specifies that the given text will be classified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.Clustering">
|
||
<summary>
|
||
Specifies that the embeddings will be used for clustering.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.QuestionAnswering">
|
||
<summary>
|
||
Specifies that the given text will be used for question answering.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.FactVerification">
|
||
<summary>
|
||
Specifies that the given text will be used for fact verification.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TaskType.CodeRetrievalQuery">
|
||
<summary>
|
||
Specifies that the given text will be used for code retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TextCompletion">
|
||
<summary>
|
||
Output text returned from a model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TextCompletion.CitationMetadata">
|
||
<summary>
|
||
Output only. Citation information for model-generated <c>output</c> in this <c>TextCompletion</c>. This field may be populated with attribution information for any text included in the <c>output</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TextCompletion.Output">
|
||
<summary>
|
||
Output only. The generated text returned from the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TextCompletion.SafetyRatings">
|
||
<summary>
|
||
Ratings for the safety of a response. There is at most one rating per category.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.AbstractText">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.AbstractText.Text">
|
||
<summary>
|
||
Required. The prompt text.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TextData">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TextPrompt">
|
||
<summary>
|
||
|
||
</summary>
|
||
<summary>
|
||
Text given to the model as a prompt. The Model will use this TextPrompt to Generate a text completion.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TextPrompt.Text">
|
||
<summary>
|
||
Required. The prompt text.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ThinkingConfig">
|
||
<summary>
|
||
Config for thinking features.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ThinkingConfig.IncludeThoughts">
|
||
<summary>
|
||
Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ThinkingConfig.ThinkingBudget">
|
||
<summary>
|
||
The number of thoughts tokens that the model should generate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ThinkingConfig.ThinkingLevel">
|
||
<summary>
|
||
Optional. Controls the maximum depth of the model's internal reasoning process before it produces a response. If not specified, the default is HIGH. Recommended for Gemini 3 or later models. Use with earlier models results in an error.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ThinkingLevel.ThinkingLevelUnspecified">
|
||
<summary>
|
||
Unspecified thinking level.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ThinkingLevel.Minimal">
|
||
<summary>
|
||
Little to no thinking.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ThinkingLevel.Low">
|
||
<summary>
|
||
Low thinking level.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ThinkingLevel.Medium">
|
||
<summary>
|
||
Medium thinking level.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.ThinkingLevel.High">
|
||
<summary>
|
||
High thinking level.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TokensInfo">
|
||
<summary>
|
||
Tokens info with a list of tokens and the corresponding list of token ids.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TokensInfo.Role">
|
||
<summary>
|
||
Optional. Optional fields for the role from the corresponding Content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TokensInfo.TokenIds">
|
||
<summary>
|
||
A list of token ids from the input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TokensInfo.Tokens">
|
||
<summary>
|
||
A list of tokens from the input.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Tool">
|
||
<summary>
|
||
Tool details that the model may use to generate response. A <c>Tool</c> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
|
||
</summary>
|
||
<summary>
|
||
Tool details that the model may use to generate response. A <c>Tool</c> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. Next ID: 15
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.EnterpriseWebSearch">
|
||
<summary>
|
||
Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.ParallelAiSearch">
|
||
<summary>
|
||
Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.Retrieval">
|
||
<summary>
|
||
Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.CodeExecution">
|
||
<summary>
|
||
Optional. Enables the model to execute code as part of generation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.ComputerUse">
|
||
<summary>
|
||
Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.FileSearch">
|
||
<summary>
|
||
Optional. FileSearch tool type. Tool to retrieve knowledge from Semantic Retrieval corpora.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.FunctionDeclarations">
|
||
<summary>
|
||
Optional. A list of <c>FunctionDeclarations</c> available to the model that can be used for function calling. The model or system does not execute the function. Instead the defined function may be returned as a FunctionCall with arguments to the client side for execution. The model may decide to call a subset of these functions by populating FunctionCall in the response. The next conversation turn may contain a FunctionResponse with the Content.role "function" generation context for the next model turn.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.GoogleMaps">
|
||
<summary>
|
||
Optional. Tool that allows grounding the model's response with geospatial context related to the user's query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.GoogleSearch">
|
||
<summary>
|
||
Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.GoogleSearchRetrieval">
|
||
<summary>
|
||
Optional. Retrieval tool that is powered by Google search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.McpServers">
|
||
<summary>
|
||
Optional. MCP Servers to connect to.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Tool.UrlContext">
|
||
<summary>
|
||
Optional. Tool to support URL context retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ToolCodeExecution">
|
||
<summary>
|
||
Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ToolComputerUse">
|
||
<summary>
|
||
Tool to support computer use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolComputerUse.Environment">
|
||
<summary>
|
||
Required. The environment being operated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolComputerUse.ExcludedPredefinedFunctions">
|
||
<summary>
|
||
Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ToolConfig">
|
||
<summary>
|
||
Tool config. This config is shared for all tools provided in the request.
|
||
</summary>
|
||
<summary>
|
||
The Tool configuration containing parameters for specifying <c>Tool</c> use in the request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolConfig.FunctionCallingConfig">
|
||
<summary>
|
||
Optional. Function calling config.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolConfig.RetrievalConfig">
|
||
<summary>
|
||
Optional. Retrieval config.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ToolGoogleSearch">
|
||
<summary>
|
||
GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolGoogleSearch.BlockingConfidence">
|
||
<summary>
|
||
Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolGoogleSearch.ExcludeDomains">
|
||
<summary>
|
||
Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ToolParallelAiSearch">
|
||
<summary>
|
||
ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding.
|
||
</summary>
|
||
<summary>
|
||
ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolParallelAiSearch.ApiKey">
|
||
<summary>
|
||
Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.ToolParallelAiSearch.CustomConfigs">
|
||
<summary>
|
||
Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only <c>source_policy</c>, <c>excerpts</c>, <c>max_results</c>, <c>mode</c>, <c>fetch_policy</c> can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Tools">
|
||
<summary>
|
||
A list of `Tool`s that can be used by the model to improve its abilities.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Tools"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.#ctor(System.Delegate[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Tools"/> class with a list of delegates as functions.
|
||
</summary>
|
||
<param name="delegates">The delegates to be added as functions.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the delegates parameter is null.</exception>
|
||
</member>
|
||
<!-- Badly formed XML comment ignored for member "M:Mscc.GenerativeAI.Types.Tools.AddGoogleSearch(System.Collections.Generic.IEnumerable{System.String},System.Nullable{Mscc.GenerativeAI.Types.BlockingConfidence})" -->
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddGoogleSearchRetrieval">
|
||
<summary>
|
||
Adds the Google Search Retrieval tool to the list of tools.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddCodeExecution">
|
||
<summary>
|
||
Adds the Code Execution tool to the list of tools.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddUrlContext">
|
||
<summary>
|
||
Adds the URL Context tool to the list of tools.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddGoogleMaps(System.Nullable{System.Boolean})">
|
||
<summary>
|
||
Adds the Google Maps tool to the list of tools.
|
||
</summary>
|
||
<param name="enableWidget">Whether to return a token and enable the Google Maps widget (default is false).</param>
|
||
</member>
|
||
<!-- Badly formed XML comment ignored for member "M:Mscc.GenerativeAI.Types.Tools.AddEnterpriseWebSearch(System.Collections.Generic.IEnumerable{System.String},System.Nullable{Mscc.GenerativeAI.Types.BlockingConfidence})" -->
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddComputerUse(System.Nullable{Mscc.GenerativeAI.Types.ComputerUseEnvironment})">
|
||
<summary>
|
||
Adds the Computer Use tool to the list of tools.
|
||
</summary>
|
||
<param name="environment">The environment being operated.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddFileSearch(System.Collections.Generic.List{System.String})">
|
||
<summary>
|
||
Adds the <see cref="T:Mscc.GenerativeAI.Types.FileSearch"/> tool to the list of tools.
|
||
</summary>
|
||
<param name="stores">List of <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>s to query.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddFunction(System.String,System.String)">
|
||
<summary>
|
||
Adds a function to the list of function declarations.
|
||
</summary>
|
||
<param name="name">The name of the function.</param>
|
||
<param name="description">The description of the function.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddFunction(System.Delegate)">
|
||
<summary>
|
||
Adds a function to the list of function declarations.
|
||
</summary>
|
||
<param name="callback">The delegate to be added as a function.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddFunction(System.String,System.Delegate)">
|
||
<summary>
|
||
Adds a function to the list of function declarations.
|
||
</summary>
|
||
<param name="name">The name of the function.</param>
|
||
<param name="callback">The delegate to be added as a function.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.AddFunction(System.String,System.String,System.Delegate)">
|
||
<summary>
|
||
Adds a function to the list of function declarations.
|
||
</summary>
|
||
<param name="name">The name of the function.</param>
|
||
<param name="description">The description of the function.</param>
|
||
<param name="callback">The delegate to be added as a function.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.RemoveFunction(System.String)">
|
||
<summary>
|
||
Removes a function from the list of function declarations by name.
|
||
</summary>
|
||
<param name="name">The name of the function to remove.</param>
|
||
<returns>True if the function was removed, false otherwise.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.RemoveFunction(System.Delegate)">
|
||
<summary>
|
||
Removes a function from the list of function declarations by delegate.
|
||
</summary>
|
||
<param name="callback">The delegate of the function to remove.</param>
|
||
<returns>True if the function was removed, false otherwise.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.ClearFunctions">
|
||
<summary>
|
||
Clears all functions from the list of function declarations.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.GetFunctions">
|
||
<summary>
|
||
Get list of available function declarations
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.Tools.Invoke(System.String,System.Object)">
|
||
<summary>
|
||
Invokes a function by name with the provided arguments.
|
||
</summary>
|
||
<param name="name">The name of the function to invoke.</param>
|
||
<param name="arguments">The arguments to pass to the function.</param>
|
||
<returns>The result of the function invocation.</returns>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TopCandidates">
|
||
<summary>
|
||
Candidates with top log probabilities at each decoding step.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TopCandidates.Candidates">
|
||
<summary>
|
||
Sorted by log probability in descending order.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TrafficType.TrafficTypeUnspecified">
|
||
<summary>
|
||
Unspecified request traffic type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TrafficType.OnDemand">
|
||
<summary>
|
||
The request was processed using Pay-As-You-Go quota.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TrafficType.ProvisionedThroughput">
|
||
<summary>
|
||
Type for Provisioned Throughput traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TrainingData">
|
||
<summary>
|
||
Dataset for training or validation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TrainingData.Examples">
|
||
<summary>
|
||
Optional. Inline examples.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TransferOwnershipRequest">
|
||
<summary>
|
||
Request to transfer the ownership of the tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TransferOwnershipRequest.EmailAddress">
|
||
<summary>
|
||
Required. The email address of the user to whom the tuned model is being transferred to.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TransferOwnershipResponse">
|
||
<summary>
|
||
Response from <c>TransferOwnership</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TransformationConfig.ChunkingConfig">
|
||
<summary>
|
||
Optional. Config for telling the service how to chunk the data.
|
||
If not provided, the service will use default parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TunedModelCheckpoint">
|
||
<summary>
|
||
TunedModelCheckpoint for the Tuned Model of a Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelCheckpoint.CheckpointId">
|
||
<summary>
|
||
The ID of the checkpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelCheckpoint.Endpoint">
|
||
<summary>
|
||
The Endpoint resource name that the checkpoint is deployed to. Format: <c>projects/{project}/locations/{location}/endpoints/{endpoint}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelCheckpoint.Epoch">
|
||
<summary>
|
||
The epoch of the checkpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelCheckpoint.Step">
|
||
<summary>
|
||
The step of the checkpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TunedModelResponse">
|
||
<summary>
|
||
The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.
|
||
</summary>
|
||
<summary>
|
||
A fine-tuned model created using ModelService.CreateTunedModel.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.Checkpoints">
|
||
<summary>
|
||
Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.Endpoint">
|
||
<summary>
|
||
Output only. A resource name of an Endpoint. Format: <c>projects/{project}/locations/{location}/endpoints/{endpoint}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.Model">
|
||
<summary>
|
||
Output only. The resource name of the TunedModel. Format: <c>projects/{project}/locations/{location}/models/{model}@{version_id}</c> When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., <c>projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.BaseModel">
|
||
<summary>
|
||
Immutable. The name of the <c>Model</c> to tune. Example: <c>models/gemini-1.5-flash-001</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.CreateTime">
|
||
<summary>
|
||
Output only. The timestamp when this model was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.Description">
|
||
<summary>
|
||
Optional. A short description of this model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.DisplayName">
|
||
<summary>
|
||
Optional. The name to display for this model in user interfaces. The display name must be up to 40 characters including spaces.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.Name">
|
||
<summary>
|
||
Output only. The tuned model name. A unique name will be generated on create. Example: <c>tunedModels/az2mb0bpw6i</c> If display_name is set on create, the id portion of the name will be set by concatenating the words of the display_name with hyphens and adding a random portion for uniqueness. Example: * display_name = <c>Sentence Translator</c> * name = <c>tunedModels/sentence-translator-u3b7m</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.ReaderProjectNumbers">
|
||
<summary>
|
||
Optional. List of project numbers that have read access to the tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.State">
|
||
<summary>
|
||
Output only. The state of the tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.Temperature">
|
||
<summary>
|
||
Optional. Controls the randomness of the output. Values can range over <c>[0.0,1.0]</c>, inclusive. A value closer to <c>1.0</c> will produce responses that are more varied, while a value closer to <c>0.0</c> will typically result in less surprising responses from the model. This value specifies default to be the one used by the base model while creating the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.TopK">
|
||
<summary>
|
||
Optional. For Top-k sampling. Top-k sampling considers the set of <c>top_k</c> most probable tokens. This value specifies default to be used by the backend while making the call to the model. This value specifies default to be the one used by the base model while creating the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.TopP">
|
||
<summary>
|
||
Optional. For Nucleus sampling. Nucleus sampling considers the smallest set of tokens whose probability sum is at least <c>top_p</c>. This value specifies default to be the one used by the base model while creating the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.TunedModelSource">
|
||
<summary>
|
||
Optional. TunedModel to use as the starting point for training the new model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.TuningTask">
|
||
<summary>
|
||
Required. The tuning task that creates the tuned model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelResponse.UpdateTime">
|
||
<summary>
|
||
Output only. The timestamp when this model was updated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TunedModelResponse.StateType.StateUnspecified">
|
||
<summary>
|
||
The default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TunedModelResponse.StateType.Creating">
|
||
<summary>
|
||
The model is being created.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TunedModelResponse.StateType.Active">
|
||
<summary>
|
||
The model is ready to be used.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TunedModelResponse.StateType.Failed">
|
||
<summary>
|
||
The model failed to be created.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TunedModelSource">
|
||
<summary>
|
||
Tuned model as a source for training a new model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelSource.BaseModel">
|
||
<summary>
|
||
Output only. The name of the base <c>Model</c> this <c>TunedModel</c> was tuned from. Example: <c>models/gemini-1.5-flash-001</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TunedModelSource.TunedModel">
|
||
<summary>
|
||
Immutable. The name of the <c>TunedModel</c> to use as the starting point for training the new model. Example: <c>tunedModels/my-tuned-model</c>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningContent">
|
||
<summary>
|
||
The structured datatype containing multi-part content of an example message. This is a subset of the Content proto used during model inference with limited type support. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
|
||
</summary>
|
||
<summary>
|
||
The structured datatype containing multi-part content of an example message. This is a subset of the Content proto used during model inference with limited type support. A <c>Content</c> includes a <c>role</c> field designating the producer of the <c>Content</c> and a <c>parts</c> field containing multi-part data that contains the content of the message turn.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningContent.Parts">
|
||
<summary>
|
||
Ordered `Parts` that constitute a single message. Parts may have different MIME types.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningContent.Role">
|
||
<summary>
|
||
Optional. The producer of the content. Must be either 'user' or 'model'.
|
||
Useful to set for multi-turn conversations, otherwise can be left blank or unset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningContent.PartTypes">
|
||
<summary>
|
||
Ordered Parts that constitute a single message. Parts may have different MIME types.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningContent.ETag">
|
||
<summary>
|
||
The ETag of the item.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.TuningContent.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Content"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.TuningContent.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Content"/> class.
|
||
</summary>
|
||
<param name="text">String to process.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.Types.TuningContent.#ctor(Mscc.GenerativeAI.Types.FileData)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.Types.Content"/> class.
|
||
</summary>
|
||
<param name="file">File to process.</param>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningDataStats">
|
||
<summary>
|
||
The tuning data statistic values for TuningJob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningDataStats.DistillationDataStats">
|
||
<summary>
|
||
Output only. Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningDataStats.PreferenceOptimizationDataStats">
|
||
<summary>
|
||
Output only. Statistics for preference optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningDataStats.SupervisedTuningDataStats">
|
||
<summary>
|
||
The SFT Tuning data stats.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningExample">
|
||
<summary>
|
||
A single example for tuning.
|
||
</summary>
|
||
<summary>
|
||
A single example for tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningExample.Output">
|
||
<summary>
|
||
Required. The expected model output.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningExample.TextInput">
|
||
<summary>
|
||
Optional. Text model input.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningExamples">
|
||
<summary>
|
||
A set of tuning examples. Can be training or validation data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningExamples.Examples">
|
||
<summary>
|
||
The examples. Example input can be for text or discuss, but all examples in a set must be of the same type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningExamples.MultiturnExamples">
|
||
<summary>
|
||
Content examples. For multiturn conversations.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningJob">
|
||
<summary>
|
||
Represents a TuningJob that runs with Google owned models.
|
||
</summary>
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.BaseModel">
|
||
<summary>
|
||
The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.CreateTime">
|
||
<summary>
|
||
Output only. Time when the TuningJob was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.CustomBaseModel">
|
||
<summary>
|
||
Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.Description">
|
||
<summary>
|
||
Optional. The description of the TuningJob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.DistillationSpec">
|
||
<summary>
|
||
Tuning Spec for Distillation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.EncryptionSpec">
|
||
<summary>
|
||
Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.EndTime">
|
||
<summary>
|
||
Output only. Time when the TuningJob entered any of the following JobStates: <c>JOB_STATE_SUCCEEDED</c>, <c>JOB_STATE_FAILED</c>, <c>JOB_STATE_CANCELLED</c>, <c>JOB_STATE_EXPIRED</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.Error">
|
||
<summary>
|
||
Output only. Only populated when job's state is <c>JOB_STATE_FAILED</c> or <c>JOB_STATE_CANCELLED</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.EvaluateDatasetRuns">
|
||
<summary>
|
||
Output only. Evaluation runs for the Tuning Job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.Experiment">
|
||
<summary>
|
||
Output only. The Experiment associated with this TuningJob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.FullFineTuningSpec">
|
||
<summary>
|
||
Tuning Spec for Full Fine Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.Labels">
|
||
<summary>
|
||
Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.Name">
|
||
<summary>
|
||
Output only. Identifier. Resource name of a TuningJob. Format: <c>projects/{project}/locations/{location}/tuningJobs/{tuning_job}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.OutputUri">
|
||
<summary>
|
||
Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.PartnerModelTuningSpec">
|
||
<summary>
|
||
Tuning Spec for open sourced and third party Partner models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.PipelineJob">
|
||
<summary>
|
||
Output only. The resource name of the PipelineJob associated with the TuningJob. Format: <c>projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.PreTunedModel">
|
||
<summary>
|
||
The pre-tuned model for continuous tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.PreferenceOptimizationSpec">
|
||
<summary>
|
||
Tuning Spec for Preference Optimization.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.SatisfiesPzi">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.SatisfiesPzs">
|
||
<summary>
|
||
Output only. Reserved for future use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.ServiceAccount">
|
||
<summary>
|
||
The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the <c>iam.serviceAccounts.actAs</c> permission on this service account.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.StartTime">
|
||
<summary>
|
||
Output only. Time when the TuningJob for the first time entered the <c>JOB_STATE_RUNNING</c> state.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.State">
|
||
<summary>
|
||
Output only. The detailed state of the job.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.SupervisedTuningSpec">
|
||
<summary>
|
||
Tuning Spec for Supervised Fine Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.TunedModel">
|
||
<summary>
|
||
Output only. The tuned model resources associated with this TuningJob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.TunedModelDisplayName">
|
||
<summary>
|
||
Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.TuningDataStats">
|
||
<summary>
|
||
Output only. The tuning data statistics associated with this TuningJob.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.TuningJobState">
|
||
<summary>
|
||
Output only. The detail state of the tuning job (while the overall <c>JobState</c> is running).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.UpdateTime">
|
||
<summary>
|
||
Output only. Time when the TuningJob was most recently updated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.VeoTuningSpec">
|
||
<summary>
|
||
Tuning Spec for Veo Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateUnspecified">
|
||
<summary>
|
||
The job state is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateQueued">
|
||
<summary>
|
||
The job has been just created or resumed and processing has not yet begun.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStatePending">
|
||
<summary>
|
||
The service is preparing to run the job.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateRunning">
|
||
<summary>
|
||
The job is in progress.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateSucceeded">
|
||
<summary>
|
||
The job completed successfully.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateFailed">
|
||
<summary>
|
||
The job failed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateCancelling">
|
||
<summary>
|
||
The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateCancelled">
|
||
<summary>
|
||
The job has been cancelled.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStatePaused">
|
||
<summary>
|
||
The job has been stopped, and can be resumed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateExpired">
|
||
<summary>
|
||
The job has expired.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStateUpdating">
|
||
<summary>
|
||
The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.StateType.JobStatePartiallySucceeded">
|
||
<summary>
|
||
The job is partially succeeded, some results may be missing due to errors.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.TuningJobStateType.TuningJobStateUnspecified">
|
||
<summary>
|
||
Default tuning job state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.TuningJobStateType.TuningJobStateWaitingForQuota">
|
||
<summary>
|
||
Tuning job is waiting for job quota.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.TuningJobStateType.TuningJobStateProcessingDataset">
|
||
<summary>
|
||
Tuning job is validating the dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.TuningJobStateType.TuningJobStateWaitingForCapacity">
|
||
<summary>
|
||
Tuning job is waiting for hardware capacity.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.TuningJobStateType.TuningJobStateTuning">
|
||
<summary>
|
||
Tuning job is running.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJob.TuningJobStateType.TuningJobStatePostProcessing">
|
||
<summary>
|
||
Tuning job is doing some post processing steps.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.Endpoint">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningJob.HasEnded">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.ListTuningJobResponse">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJobState.TuningJobStateUnspecified">
|
||
<summary>
|
||
Default tuning job state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJobState.TuningJobStateWaitingForQuota">
|
||
<summary>
|
||
Tuning job is waiting for job quota.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJobState.TuningJobStateProcessingDataset">
|
||
<summary>
|
||
Tuning job is validating the dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJobState.TuningJobStateWaitingForCapacity">
|
||
<summary>
|
||
Tuning job is waiting for hardware capacity.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJobState.TuningJobStateTuning">
|
||
<summary>
|
||
Tuning job is running.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningJobState.TuningJobStatePostProcessing">
|
||
<summary>
|
||
Tuning job is doing some post processing steps.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningMode.TuningModeUnspecified">
|
||
<summary>
|
||
Tuning mode is unspecified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningMode.TuningModeFull">
|
||
<summary>
|
||
Full fine-tuning mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TuningMode.TuningModePeftAdapter">
|
||
<summary>
|
||
PEFT adapter tuning mode.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningMultiturnExample">
|
||
<summary>
|
||
A tuning example with multiturn input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningMultiturnExample.Contents">
|
||
<summary>
|
||
Each Content represents a turn in the conversation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningMultiturnExample.SystemInstruction">
|
||
<summary>
|
||
Optional. Developer set system instructions. Currently, text only.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningPart">
|
||
<summary>
|
||
A datatype containing data that is part of a multi-part `TuningContent` message.
|
||
This is a subset of the Part used for model inference, with limited type support.
|
||
A `Part` consists of data which has an associated datatype.
|
||
A `Part` can only contain one of the accepted types in `Part.data`.
|
||
</summary>
|
||
<summary>
|
||
A datatype containing data that is part of a multi-part <c>TuningContent</c> message. This is a subset of the Part used for model inference, with limited type support. A <c>Part</c> consists of data which has an associated datatype. A <c>Part</c> can only contain one of the accepted types in <c>Part.data</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningPart.Text">
|
||
<summary>
|
||
Inline text.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningSnapshot">
|
||
<summary>
|
||
Record for a single tuning step.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningSnapshot.ComputeTime">
|
||
<summary>
|
||
Output only. The timestamp when this metric was computed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningSnapshot.Epoch">
|
||
<summary>
|
||
Output only. The epoch this step was part of.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningSnapshot.MeanLoss">
|
||
<summary>
|
||
Output only. The mean loss of the training examples for this step.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningSnapshot.Step">
|
||
<summary>
|
||
Output only. The tuning step.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TuningTask">
|
||
<summary>
|
||
Tuning tasks that create tuned models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningTask.CompleteTime">
|
||
<summary>
|
||
Output only. The timestamp when tuning this model completed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningTask.Hyperparameters">
|
||
<summary>
|
||
Immutable. Hyperparameters controlling the tuning process. If not provided, default values will be used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningTask.Snapshots">
|
||
<summary>
|
||
Output only. Metrics collected during tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningTask.StartTime">
|
||
<summary>
|
||
Output only. The timestamp when tuning this model started.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.TuningTask.TrainingData">
|
||
<summary>
|
||
Required. Input only. Immutable. The model training data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.TurnCoverage">
|
||
<summary>
|
||
Defines which input is included in the user's turn.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TurnCoverage.TurnCoverageUnspecified">
|
||
<summary>
|
||
If unspecified, the default behavior is `TURN_INCLUDES_ONLY_ACTIVITY`.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TurnCoverage.TurnIncludesOnlyActivity">
|
||
<summary>
|
||
The users turn only includes activity since the last turn, excluding inactivity (e.g. silence on the audio stream). This is the default behavior.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.TurnCoverage.TurnIncludesAllInput">
|
||
<summary>
|
||
The users turn includes all realtime input since the last turn, including inactivity (e.g. silence on the audio stream).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UpdateChunkRequest">
|
||
<summary>
|
||
Request to update a <see cref="P:Mscc.GenerativeAI.Types.UpdateChunkRequest.Chunk"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpdateChunkRequest.Chunk">
|
||
<summary>
|
||
Required. The <see cref="P:Mscc.GenerativeAI.Types.UpdateChunkRequest.Chunk"/> to update.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpdateChunkRequest.UpdateMask">
|
||
<summary>
|
||
Required. The list of fields to update. Currently, this only supports updating <see cref="!:custom_metadata"/> and <see cref="!:data"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UploadFileConfig">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadFileConfig.Name">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadFileConfig.DisplayName">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadFileConfig.MimeType">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UploadMediaRequest">
|
||
<summary>
|
||
Instance to upload a local file to create a File resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadMediaRequest.File">
|
||
<summary>
|
||
Optional. Metadata for the file to create.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UploadMediaResponse">
|
||
<summary>
|
||
Information about an uploaded file via FIle API
|
||
Ref: https://ai.google.dev/api/rest/v1beta/files
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadMediaResponse.File">
|
||
<summary>
|
||
Metadata for the created file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest">
|
||
<summary>
|
||
Request for <c>UploadToFileSearchStore</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest.ChunkingConfig">
|
||
<summary>
|
||
Optional. Config for telling the service how to chunk the data. If not provided, the service will use default parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest.CustomMetadata">
|
||
<summary>
|
||
Custom metadata to be associated with the data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest.DisplayName">
|
||
<summary>
|
||
Optional. Display name of the created document.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest.MimeType">
|
||
<summary>
|
||
Optional. MIME type of the data. If not provided, it will be inferred from the uploaded content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UploadToRagStoreRequest">
|
||
<summary>
|
||
Request for `UploadToRagStore`.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToRagStoreRequest.ChunkingConfig">
|
||
<summary>
|
||
Optional. Config for telling the service how to chunk the data.
|
||
If not provided, the service will use default parameters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToRagStoreRequest.CustomMetadata">
|
||
<summary>
|
||
Custom metadata to be associated with the data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToRagStoreRequest.DisplayName">
|
||
<summary>
|
||
Optional. Display name of the created document.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UploadToRagStoreRequest.MimeType">
|
||
<summary>
|
||
Optional. MIME type of the data.
|
||
If not provided, it will be inferred from the uploaded content.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UpscaleConfig">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpscaleConfig.UpscaleFactor">
|
||
<summary>
|
||
Optional. When upscaling, the factor to which the image will be upscaled.
|
||
If not specified, the upscale factor will be determined from the longer side of the input image and sampleImageSize.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UpscaleFactor">
|
||
<summary>
|
||
The factor to upscale the image (x2 or x4).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UpscaleFactor.X2">
|
||
<summary>
|
||
Upscale factor 2
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UpscaleFactor.X4">
|
||
<summary>
|
||
Upscale factor 4
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UpscaleImageConfig">
|
||
<summary>
|
||
Configuration for upscaling an image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpscaleImageConfig.OutputCompressionQuality">
|
||
<summary>
|
||
The level of compression if the output_mime_type is image/jpeg.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpscaleImageConfig.OutputMimeType">
|
||
<summary>
|
||
The image format that the output should be saved as.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UpscaleImageRequest">
|
||
<summary>
|
||
Request for image upscaling.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpscaleImageRequest.Config">
|
||
<summary>
|
||
Configuration for image upscaling.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UpscaleImageResponse">
|
||
<summary>
|
||
Response for the request to upscale an image.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpscaleImageResponse.Images">
|
||
<summary>
|
||
Output only. A list of the generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UpscaleImageResponse.GeneratedImages">
|
||
<summary>
|
||
List of generated images.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UrlContext">
|
||
<summary>
|
||
Tool to support URL context.
|
||
</summary>
|
||
<summary>
|
||
Tool to support URL context retrieval.
|
||
</summary>
|
||
<summary>
|
||
Tool to support URL context retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UrlContextMetadata">
|
||
<summary>
|
||
Metadata returned when the model uses the <c>url_context</c> tool to get information from a user-provided URL.
|
||
</summary>
|
||
<summary>
|
||
Metadata related to url context retrieval tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UrlContextMetadata.UrlMetadata">
|
||
<summary>
|
||
List of url context.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UrlMetadata">
|
||
<summary>
|
||
The metadata for a single URL retrieval.
|
||
</summary>
|
||
<summary>
|
||
Context of the a single url retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UrlMetadata.RetrievedUrl">
|
||
<summary>
|
||
Retrieved url by the tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UrlMetadata.UrlRetrievalStatus">
|
||
<summary>
|
||
Status of the url retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UrlRetrievalContext">
|
||
<summary>
|
||
Context of the a single url retrieval.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UrlRetrievalContext.RetrievedUrl">
|
||
<summary>
|
||
Retrieved url by the tool.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UrlRetrievalMetadata">
|
||
<summary>
|
||
Metadata related to url context retrieval tool.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UrlRetrievalMetadata.UrlRetrievalContexts">
|
||
<summary>
|
||
List of url retrieval contexts.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UrlRetrievalStatus.UrlRetrievalStatusUnspecified">
|
||
<summary>
|
||
Default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UrlRetrievalStatus.UrlRetrievalStatusSuccess">
|
||
<summary>
|
||
Url retrieval is successful.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UrlRetrievalStatus.UrlRetrievalStatusError">
|
||
<summary>
|
||
Url retrieval is failed due to error.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UrlRetrievalStatus.UrlRetrievalStatusPaywall">
|
||
<summary>
|
||
Url retrieval is failed because the content is behind paywall.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UrlRetrievalStatus.UrlRetrievalStatusUnsafe">
|
||
<summary>
|
||
Url retrieval is failed because the content is unsafe.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.UsageMetadata">
|
||
<summary>
|
||
Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.
|
||
</summary>
|
||
<summary>
|
||
Usage metadata about the content generation request and response. This message provides a
|
||
detailed breakdown of token usage and other relevant metrics. This data type is not supported
|
||
in Gemini API.
|
||
</summary>
|
||
<summary>
|
||
Metadata on the generation request's token usage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.TrafficType">
|
||
<summary>
|
||
Output only. The traffic type for this request.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UsageMetadata.UsageMetadataTrafficType.TrafficTypeUnspecified">
|
||
<summary>
|
||
Unspecified request traffic type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UsageMetadata.UsageMetadataTrafficType.OnDemand">
|
||
<summary>
|
||
Type for Pay-As-You-Go traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UsageMetadata.UsageMetadataTrafficType.OnDemandPriority">
|
||
<summary>
|
||
Type for Priority Pay-As-You-Go traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UsageMetadata.UsageMetadataTrafficType.OnDemandFlex">
|
||
<summary>
|
||
Type for Flex traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.UsageMetadata.UsageMetadataTrafficType.ProvisionedThroughput">
|
||
<summary>
|
||
Type for Provisioned Throughput traffic.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.TextCount">
|
||
<summary>
|
||
Number of text characters.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.ImageCount">
|
||
<summary>
|
||
Number of images.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.VideoDurationSeconds">
|
||
<summary>
|
||
Duration of video in seconds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.AudioDurationSeconds">
|
||
<summary>
|
||
Duration of audio in seconds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.CacheTokensDetails">
|
||
<summary>
|
||
Output only. List of modalities of the cached content in the request input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.CachedContentTokenCount">
|
||
<summary>
|
||
Number of tokens in the cached part of the prompt (the cached content)
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.CandidatesTokenCount">
|
||
<summary>
|
||
Total number of tokens across all the generated response candidates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.CandidatesTokensDetails">
|
||
<summary>
|
||
Output only. List of modalities that were returned in the response.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.PromptTokenCount">
|
||
<summary>
|
||
Number of tokens in the prompt. When <c>cached_content</c> is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.PromptTokensDetails">
|
||
<summary>
|
||
Output only. List of modalities that were processed in the request input.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.ThoughtsTokenCount">
|
||
<summary>
|
||
Output only. Number of tokens of thoughts for thinking models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.ToolUsePromptTokenCount">
|
||
<summary>
|
||
Output only. Number of tokens present in tool-use prompt(s).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.ToolUsePromptTokensDetails">
|
||
<summary>
|
||
Output only. List of modalities that were processed for tool-use request inputs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.UsageMetadata.TotalTokenCount">
|
||
<summary>
|
||
Total token count for the generation request (prompt + response candidates).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VeoHyperParameters">
|
||
<summary>
|
||
Hyperparameters for Veo.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VeoHyperParameters.EpochCount">
|
||
<summary>
|
||
Optional. Number of complete passes the model makes over the entire training dataset during training.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VeoHyperParameters.LearningRateMultiplier">
|
||
<summary>
|
||
Optional. Multiplier for adjusting the default learning rate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VeoHyperParameters.TuningTask">
|
||
<summary>
|
||
Optional. The tuning task. Either I2V or T2V.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VeoHyperParameters.VeoDataMixtureRatio">
|
||
<summary>
|
||
Optional. The ratio of Google internal dataset to use in the training mixture, in range of <c>[0, 1)</c>. If <c>0.2</c>, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.VeoHyperParameters.TuningTaskType.TuningTaskUnspecified">
|
||
<summary>
|
||
Default value. This value is unused.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.VeoHyperParameters.TuningTaskType.TuningTaskI2v">
|
||
<summary>
|
||
Tuning task for image to video.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.VeoHyperParameters.TuningTaskType.TuningTaskT2v">
|
||
<summary>
|
||
Tuning task for text to video.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.Types.VeoHyperParameters.TuningTaskType.TuningTaskR2v">
|
||
<summary>
|
||
Tuning task for reference to video.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VeoTuningSpec">
|
||
<summary>
|
||
Tuning Spec for Veo Model Tuning.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VeoTuningSpec.HyperParameters">
|
||
<summary>
|
||
Optional. Hyperparameters for Veo.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VeoTuningSpec.TrainingDatasetUri">
|
||
<summary>
|
||
Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VeoTuningSpec.ValidationDatasetUri">
|
||
<summary>
|
||
Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VertexAISearch">
|
||
<summary>
|
||
Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAISearch.DataStoreSpecs">
|
||
<summary>
|
||
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAISearch.Datastore">
|
||
<summary>
|
||
Optional. Fully-qualified Vertex AI Search data store resource ID. Format: <c>projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAISearch.Engine">
|
||
<summary>
|
||
Optional. Fully-qualified Vertex AI Search engine resource ID. Format: <c>projects/{project}/locations/{location}/collections/{collection}/engines/{engine}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAISearch.Filter">
|
||
<summary>
|
||
Optional. Filter strings to be passed to the search API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAISearch.MaxResults">
|
||
<summary>
|
||
Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VertexAiSearchConfig">
|
||
<summary>
|
||
Config for the Vertex AI Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAiSearchConfig.ServingConfig">
|
||
<summary>
|
||
Vertex AI Search Serving Config resource full name. For example, <c>projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}</c> or <c>projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VertexAISearchDataStoreSpec">
|
||
<summary>
|
||
Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAISearchDataStoreSpec.DataStore">
|
||
<summary>
|
||
Full resource name of DataStore, such as Format: <c>projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexAISearchDataStoreSpec.Filter">
|
||
<summary>
|
||
Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexFeatureStore.FeatureViewResourceName">
|
||
<summary>
|
||
The Vertex AI Feature Store FeatureView that the RAG corpus maps to.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexPredictionEndpoint.Endpoint">
|
||
<summary>
|
||
The embedding model to use for the RAG corpus.
|
||
</summary>
|
||
<remarks>
|
||
This value can't be changed after it's set.
|
||
If you leave it empty, we use `text-embedding-004` as the embedding model.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VertexRagStore">
|
||
<summary>
|
||
Retrieve from Vertex RAG Store for grounding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStore.RagCorpora">
|
||
<summary>
|
||
Optional. Deprecated. Please use rag_resources instead.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStore.RagResources">
|
||
<summary>
|
||
Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStore.RagRetrievalConfig">
|
||
<summary>
|
||
Optional. The retrieval config for the Rag query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStore.SimilarityTopK">
|
||
<summary>
|
||
Optional. Number of top k results to return from the selected corpora.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStore.StoreContext">
|
||
<summary>
|
||
Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if <c>store_context</c> bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStore.VectorDistanceThreshold">
|
||
<summary>
|
||
Optional. Only return results with vector distance smaller than the threshold.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VertexRagStoreRagResource">
|
||
<summary>
|
||
The definition of the Rag resource.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStoreRagResource.RagCorpus">
|
||
<summary>
|
||
Optional. RagCorpora resource name. Format: <c>projects/{project}/locations/{location}/ragCorpora/{rag_corpus}</c>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexRagStoreRagResource.RagFileIds">
|
||
<summary>
|
||
Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VertexVectorSearch">
|
||
<summary>
|
||
Vertex Vector Search instance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexVectorSearch.Index">
|
||
<summary>
|
||
This is the resource name of the Vector Search index that's used with the RAG corpus.
|
||
</summary>
|
||
<remarks>
|
||
Format: projects/{project}/locations/{location}/indexes/{index}
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VertexVectorSearch.IndexEndpoint">
|
||
<summary>
|
||
The resource name of the Vector Search Index Endpoint
|
||
</summary>
|
||
<remarks>
|
||
Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Video">
|
||
<summary>
|
||
A generated video.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Video.Uri">
|
||
<summary>
|
||
Path to another storage.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Video.VideoBytes">
|
||
<summary>
|
||
Video bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Video.MimeType">
|
||
<summary>
|
||
Video encoding, for example \"video/mp4\".
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VideoFileMetadata">
|
||
<summary>
|
||
Metadata for a video <see cref="T:System.IO.File"/>.
|
||
</summary>
|
||
<summary>
|
||
Metadata for a video <c>File</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VideoFileMetadata.StartOffset">
|
||
<summary>
|
||
Starting offset of a video.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VideoFileMetadata.EndOffset">
|
||
<summary>
|
||
Ending offset of a video. Should be larger than the <see cref="P:Mscc.GenerativeAI.Types.VideoFileMetadata.StartOffset"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VideoFileMetadata.VideoDuration">
|
||
<summary>
|
||
Duration of the video.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VideoMetadata">
|
||
<summary>
|
||
Provides metadata for a video, including the start and end offsets for clipping and the frame rate.
|
||
</summary>
|
||
<summary>
|
||
Metadata describes the input video content.
|
||
</summary>
|
||
<summary>
|
||
Deprecated: Use <c>GenerateContentRequest.processing_options</c> instead. Metadata describes the input video content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VideoMetadata.EndOffset">
|
||
<summary>
|
||
Optional. The end offset of the video.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VideoMetadata.Fps">
|
||
<summary>
|
||
Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VideoMetadata.StartOffset">
|
||
<summary>
|
||
Optional. The start offset of the video.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VisionGenerativeModelResult">
|
||
<summary>
|
||
Represents the result from a vision generative model.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.VoiceConfig">
|
||
<summary>
|
||
Configuration for a voice.
|
||
</summary>
|
||
<summary>
|
||
The configuration for the voice to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VoiceConfig.ReplicatedVoiceConfig">
|
||
<summary>
|
||
Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.VoiceConfig.PrebuiltVoiceConfig">
|
||
<summary>
|
||
The configuration for the prebuilt voice to use.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Weaviate">
|
||
<summary>
|
||
Specifies your Weaviate instance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Weaviate.HttpEndpoint">
|
||
<summary>
|
||
The Weaviate instance's HTTP endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Weaviate.CollectionName">
|
||
<summary>
|
||
The Weaviate collection that the RAG corpus maps to.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.Web">
|
||
<summary>
|
||
Chunk from the web.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Web.Title">
|
||
<summary>
|
||
Output only. Title of the chunk.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.Web.Uri">
|
||
<summary>
|
||
Output only. URI reference of the chunk.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.WebChunk">
|
||
<summary>
|
||
A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the
|
||
web page, the title of the page, and the domain of the page. This is used to provide the user
|
||
with a link to the source of the information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.WebChunk.Domain">
|
||
<summary>
|
||
The domain of the web page that contains the evidence. This can be used to filter out
|
||
low-quality sources. This field is not supported in Gemini API.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.WebChunk.Uri">
|
||
<summary>
|
||
The URI of the web page that contains the evidence.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.WebChunk.Title">
|
||
<summary>
|
||
The title of the web page that contains the evidence.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.WebSearch">
|
||
<summary>
|
||
Standard web search for grounding and related configurations.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.WhiteSpaceConfig">
|
||
<summary>
|
||
Configuration for a white space chunking algorithm [white space delimited].
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.WhiteSpaceConfig.MaxOverlapTokens">
|
||
<summary>
|
||
Maximum number of overlapping tokens between two adjacent chunks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.WhiteSpaceConfig.MaxTokensPerChunk">
|
||
<summary>
|
||
Maximum number of tokens per chunk. Tokens are defined as words for this chunking algorithm. Note: we are defining tokens as words split by whitespace as opposed to the output of a tokenizer. The context window of the latest gemini embedding model as of 2025-04-17 is currently 8192 tokens. We assume that the average word is 5 characters. Therefore, we set the upper limit to 2**9, which is 512 words, or 2560 tokens, assuming worst case a character per token. This is a conservative estimate meant to prevent context window overflow.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Types.XraiAttribution">
|
||
<summary>
|
||
An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.XraiAttribution.BlurBaselineConfig">
|
||
<summary>
|
||
Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.XraiAttribution.SmoothGradConfig">
|
||
<summary>
|
||
Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Types.XraiAttribution.StepCount">
|
||
<summary>
|
||
Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.ToSnakeCase(System.String)">
|
||
<summary>
|
||
Converts a given string to snake case.
|
||
</summary>
|
||
<param name="text">The string to be converted to snake case.</param>
|
||
<returns>The resulting snake case string.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.ToCamelCase(System.String,System.Boolean,System.Boolean)">
|
||
<summary>
|
||
Converts a given string to camel case.
|
||
</summary>
|
||
<param name="text">The string to be converted to camel case.</param>
|
||
<param name="removeWhitespace">Whether to remove whitespace or not.</param>
|
||
<param name="preserveLeadingUnderscore">Whether to preserve the leading underscore or not.</param>
|
||
<returns>The resulting camel case string.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.ToPascalCase(System.String)">
|
||
<summary>
|
||
Converts the specified string to PascalCase.
|
||
</summary>
|
||
<param name="text">The string to convert.</param>
|
||
<returns>The PascalCase version of the string.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.SplitCamelCase(System.String,System.String)">
|
||
<summary>
|
||
Splits a given camel case string into separate words using the specified separator.
|
||
</summary>
|
||
<param name="input">The camel case string to be split.</param>
|
||
<param name="splitWith">The separator to be used. By default, a single space is used.</param>
|
||
<returns>The resulting string with words separated by the specified separator.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.ToKebabCase(System.String)">
|
||
<summary>
|
||
Converts a string to kebab-case, with words separated by hyphens.
|
||
</summary>
|
||
<param name="text">The input string to be converted to kebab-case.</param>
|
||
<returns>A kebab-case representation of the input string.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.ToTitleCase(System.String)">
|
||
<summary>
|
||
Extension method to convert a given string to title case.
|
||
</summary>
|
||
<param name="text">The string to convert to title case.</param>
|
||
<returns>A new string with each word in title case.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.ToTrainCase(System.String)">
|
||
<summary>
|
||
Convert a string to Train Case
|
||
</summary>
|
||
<param name="text"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.InsertCharacterBeforeUpperCase(System.String,System.Char)">
|
||
<summary>
|
||
Insert any character before all upper space characters in a string
|
||
</summary>
|
||
<param name="text"></param>
|
||
<param name="character"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.InsertSpaceBeforeUpperCase(System.String)">
|
||
<summary>
|
||
Insert a space before any upper case character in a string
|
||
</summary>
|
||
<param name="text"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.Replace(System.String,System.Char[],System.String)">
|
||
<summary>
|
||
Replace specific characters found in a string
|
||
See: https://stackoverflow.com/a/7265786/7986443
|
||
</summary>
|
||
<param name="s"></param>
|
||
<param name="separators"></param>
|
||
<param name="newVal"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.ReplaceWhitespace(System.String,System.String)">
|
||
<summary>
|
||
Replace all whitespace in a string
|
||
See: https://stackoverflow.com/questions/6219454/efficient-way-to-remove-all-whitespace-from-string
|
||
</summary>
|
||
<param name="input"></param>
|
||
<param name="replacement"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.IsAllUpper(System.String)">
|
||
<summary>
|
||
Extension method to check if all the letters in the input string are uppercase.
|
||
</summary>
|
||
<param name="input">The string to check for uppercase letters.</param>
|
||
<returns>True if all the letters in the input string are uppercase, otherwise false.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.SnakeCaseToCamelCase(System.String)">
|
||
<summary>
|
||
Convert SnakeCase to CamelCase
|
||
See: https://www.codegrepper.com/code-examples/csharp/camelCase+and+snakeCase
|
||
</summary>
|
||
<param name="text"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.FirstCharToLowerCase(System.String)">
|
||
<summary>
|
||
Convert the first character in a string to lower case
|
||
See: https://stackoverflow.com/questions/21755757/first-character-of-string-lowercase-c-sharp/21755933
|
||
</summary>
|
||
<param name="text"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ConverterExtensions.FirstCharToUpperCase(System.String)">
|
||
<summary>
|
||
Convert the first character in a string to upper case
|
||
</summary>
|
||
<param name="text"></param>
|
||
<returns>string</returns>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.CorporaModel">
|
||
<summary>
|
||
The `CorporaModel` class provides methods for interacting with a corpus of documents.
|
||
</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(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.CorporaModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CorporaModel.Create(Mscc.GenerativeAI.Types.Corpus,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates an empty `Corpus`.
|
||
</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CorporaModel.Update(System.String,Mscc.GenerativeAI.Types.Corpus,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates a `Corpus`.
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="corpus"></param>
|
||
<param name="updateMask"></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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CorporaModel.List(System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Lists all `Corpora` owned by the user.
|
||
</summary>
|
||
<param name="pageSize">The maximum number of Corpora to return (per page).</param>
|
||
<param name="pageToken">A page token, received from a previous List call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CorporaModel.Get(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets information about a specific `Corpus`.
|
||
</summary>
|
||
<param name="name">Name od the corpus.</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CorporaModel.Delete(System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes a `Corpus`.
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="force"></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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.CorporaModel.Query(Mscc.GenerativeAI.Types.CorpusQueryRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Performs semantic search over a `Corpus`.
|
||
</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DocumentsModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.DocumentsModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DocumentsModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.DocumentsModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DocumentsModel.Create(Mscc.GenerativeAI.Types.Document,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates an empty <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="request"></param>
|
||
<param name="parent">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> where this <see cref="T:Mscc.GenerativeAI.Types.Document"/> exists. Example: `ragStores/my-rag-store-123`</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="parent"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DocumentsModel.Delete(System.String,System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes a <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="name">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.Document"/>.</param>
|
||
<param name="parent">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> where this <see cref="T:Mscc.GenerativeAI.Types.Document"/> exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="force"></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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="parent"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="name"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DocumentsModel.Get(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets information about a specific <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="name">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.Document"/>.</param>
|
||
<param name="parent">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> where this <see cref="T:Mscc.GenerativeAI.Types.Document"/> exists. Example: `ragStores/my-rag-store-123`</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="parent"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="name"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DocumentsModel.List(System.String,System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Lists all <see cref="T:Mscc.GenerativeAI.Types.Document"/>s in a <see cref="T:Mscc.GenerativeAI.Types.Corpus"/>.
|
||
</summary>
|
||
<param name="parent">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> where this <see cref="T:Mscc.GenerativeAI.Types.Document"/> exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="pageSize">The maximum number of items to return (per page).</param>
|
||
<param name="pageToken">A page token, received from a previous List call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="parent"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DocumentsModel.Query(Mscc.GenerativeAI.Types.QueryDocumentRequest,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Performs semantic search over a <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="request"></param>
|
||
<param name="name">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.Document"/>.</param>
|
||
<param name="parent">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> where this <see cref="T:Mscc.GenerativeAI.Types.Document"/> exists. Example: `ragStores/my-rag-store-123`</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="parent"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="name"/> 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.DocumentsModel.Patch(Mscc.GenerativeAI.Types.Document,System.String,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates a <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="corpus"></param>
|
||
<param name="name">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.Document"/>.</param>
|
||
<param name="parent">Required. The name of the <see cref="T:Mscc.GenerativeAI.Types.Corpus"/> where this <see cref="T:Mscc.GenerativeAI.Types.Document"/> exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="updateMask"></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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DynamicModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.DynamicModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DynamicModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.DynamicModel"/> class.
|
||
The default constructor attempts to read <c>.env</c> file and environment variables.
|
||
Sets default values, if available.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DynamicModel.GenerateContent(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates a model response given an input `GenerateContentRequest`.
|
||
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.
|
||
</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.DynamicModel.GenerateContentStream(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates a [streamed response](https://ai.google.dev/gemini-api/docs/text-generation?lang=python#generate-a-text-stream) from the model given an input `GenerateContentRequest`.
|
||
</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></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(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.EmbeddingsModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.EmbeddingsModel.Embeddings(Mscc.GenerativeAI.Types.GenerateEmbeddingsRequest,Mscc.GenerativeAI.Types.RequestOptions,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="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>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.FileSearchStoresModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.FileSearchStoresModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.Create(Mscc.GenerativeAI.Types.FileSearchStore,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates an empty <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>.
|
||
</summary>
|
||
<param name="request">Required. The `FileSearchStore`.</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></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the request is null.</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.FileSearchStoresModel.Delete(System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>.
|
||
</summary>
|
||
<param name="fileSearchStoreName">Required. Immutable. The name of the `FileSearchStore` to import the file into. Example: `fileSearchStores/my-file-search-store-123`</param>
|
||
<param name="force">Optional. If set to true, any `Chunk`s and objects related to this `Document` will also be deleted. If false (the default), a `FAILED_PRECONDITION` error will be returned if `Document` contains any `Chunk`s.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="fileSearchStoreName"/> 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.FileSearchStoresModel.Get(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets information about a specific <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>.
|
||
</summary>
|
||
<param name="fileSearchStoreName">Required. Immutable. The name of the `FileSearchStore` to import the file into. Example: `fileSearchStores/my-file-search-store-123`</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="fileSearchStoreName"/> 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.FileSearchStoresModel.List(System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Lists all <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>s owned by the user.
|
||
</summary>
|
||
<param name="pageSize">The maximum number of items to return (per page).</param>
|
||
<param name="pageToken">A page token, received from a previous List call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</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></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.FileSearchStoresModel.ImportFile(System.String,Mscc.GenerativeAI.Types.ImportFileRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Imports a <see cref="T:Mscc.GenerativeAI.Types.FileResource"/> from File Service to a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>.
|
||
</summary>
|
||
<param name="name">Required. Immutable. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> to import the file into. Example: `fileSearchStores/my-file-search-store-123`</param>
|
||
<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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="name"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.ImportFile(System.String,Mscc.GenerativeAI.Types.FileResource,System.Collections.Generic.List{Mscc.GenerativeAI.Types.CustomMetadata},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Imports a <see cref="T:Mscc.GenerativeAI.Types.FileResource"/> from File Service to a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>.
|
||
</summary>
|
||
<param name="name">Required. Immutable. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> to import the file into. Example: `fileSearchStores/my-file-search-store-123`</param>
|
||
<param name="fileResource">The <see cref="T:Mscc.GenerativeAI.Types.FileResource"/> from the Files API.</param>
|
||
<param name="customMetadata">Custom metadata to be associated with the file.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="name"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="fileResource"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.ImportFile(System.String,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.CustomMetadata},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Imports a <see cref="T:Mscc.GenerativeAI.Types.FileResource"/> from File Service to a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>.
|
||
</summary>
|
||
<param name="name">Required. Immutable. The name of the <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> to import the file into. Example: `fileSearchStores/my-file-search-store-123`</param>
|
||
<param name="filename">Name of the <see cref="T:Mscc.GenerativeAI.Types.FileResource"/>.</param>
|
||
<param name="customMetadata">Custom metadata to be associated with the file.</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>An operation of the imported file.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="name"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="filename"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.Upload(System.String,System.String,System.String,Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Uploads data to a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>, preprocesses and chunks before storing it in a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> Document.
|
||
</summary>
|
||
<param name="name">Name of the File Search Store.</param>
|
||
<param name="file">URI or path to the file to upload.</param>
|
||
<param name="displayName">A name displayed for the uploaded file.</param>
|
||
<param name="config">Configuration settings for the uploaded file.</param>
|
||
<param name="resumable">Flag indicating whether to use resumable upload.</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>An operation of the uploaded file.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is null or empty.</exception>
|
||
<exception cref="T:System.IO.FileNotFoundException">Thrown when the file <paramref name="file"/> is not found.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.MaxUploadFileSizeException">Thrown when the file size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.UploadFileException">Thrown when the file upload fails.</exception>
|
||
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the MIME type of the URI is not supported by the API.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.Upload(System.String,System.IO.Stream,System.String,System.String,Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Uploads data to a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>, preprocesses and chunks before storing it in a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> Document.
|
||
</summary>
|
||
<param name="name">Name of the File Search Store.</param>
|
||
<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="config">Configuration settings for the uploaded file.</param>
|
||
<param name="resumable">Flag indicating whether to use resumable upload.</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>An operation 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.Types.MaxUploadFileSizeException">Thrown when the <paramref name="stream"/> size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.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>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="mimeType"/> is not supported by the API.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.UploadToFileSearchStore(System.String,System.String,Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Compatibility method with Google SDK. Use <see cref="M:Mscc.GenerativeAI.FileSearchStoresModel.Upload(System.String,System.String,System.String,Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)"/> for convenience.
|
||
</summary>
|
||
<param name="fileSearchStoreName">Name of the File Search Store.</param>
|
||
<param name="file">URI or path to the file to upload.</param>
|
||
<param name="config">Configuration settings for the uploaded file.</param>
|
||
<param name="resumable">Flag indicating whether to use resumable upload.</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>An operation of the uploaded file.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FileSearchStoresModel.UploadToFileSearchStore(System.String,System.IO.Stream,System.String,System.String,Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Compatibility method with Google SDK. Use <see cref="M:Mscc.GenerativeAI.FileSearchStoresModel.Upload(System.String,System.String,System.String,Mscc.GenerativeAI.Types.UploadToFileSearchStoreRequest,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)"/> for convenience.
|
||
</summary>
|
||
<param name="fileSearchStoreName">Name of the File Search Store.</param>
|
||
<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="config">Configuration settings for the uploaded file.</param>
|
||
<param name="resumable">Flag indicating whether to use resumable upload.</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>An operation 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.Types.MaxUploadFileSizeException">Thrown when the <paramref name="stream"/> size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.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>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="mimeType"/> is not supported by the API.</exception>
|
||
</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(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.FilesModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FilesModel.ListFiles(System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.FilesModel.RegisterFiles(Mscc.GenerativeAI.Types.RegisterFilesRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Registers a Google Cloud Storage files with FileService.
|
||
The user is expected to provide Google Cloud Storage URIs and will receive a File resource
|
||
for each URI in return. Note that the files are not copied, just registered with File API.
|
||
If one file fails to register, the whole request fails.
|
||
</summary>
|
||
<param name="request">Request with GCS Uris to register.</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></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.FlexibleEnumConverterFactory">
|
||
<summary>
|
||
A custom JSON converter factory for enums that allows for flexible parsing.
|
||
It can handle enums represented as strings (including snake_case and kebab-case)
|
||
and integers.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FlexibleEnumConverterFactory.CanConvert(System.Type)">
|
||
<summary>
|
||
Determines whether this converter can convert the specified type.
|
||
</summary>
|
||
<param name="typeToConvert">The type to check.</param>
|
||
<returns><c>true</c> if the type is an enum; otherwise, <c>false</c>.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FlexibleEnumConverterFactory.CreateConverter(System.Type,System.Text.Json.JsonSerializerOptions)">
|
||
<summary>
|
||
Creates a converter for the specified type.
|
||
</summary>
|
||
<param name="typeToConvert">The type to convert.</param>
|
||
<param name="options">The JSON serializer options.</param>
|
||
<returns>A new instance of the generic <see cref="T:Mscc.GenerativeAI.FlexibleEnumConverterFactory.FlexibleEnumConverter`1"/>.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FlexibleEnumConverterFactory.FlexibleEnumConverter`1.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
|
||
<summary>
|
||
Reads and converts the JSON to type <typeparamref name="TEnum"/>.
|
||
</summary>
|
||
<param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader"/> to read from.</param>
|
||
<param name="typeToConvert">The type to convert.</param>
|
||
<param name="options">The JSON serializer options.</param>
|
||
<returns>The converted enum value.</returns>
|
||
<exception cref="T:System.Text.Json.JsonException">Thrown if the JSON value cannot be converted to the enum type.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.FlexibleEnumConverterFactory.FlexibleEnumConverter`1.Write(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)">
|
||
<summary>
|
||
Writes a specified value as JSON.
|
||
</summary>
|
||
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter"/> to write to.</param>
|
||
<param name="value">The value to write.</param>
|
||
<param name="options">The JSON serializer options.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerateContentResponseExtensions.Merge(System.Collections.Generic.IEnumerable{Mscc.GenerativeAI.Types.GenerateContentResponse})">
|
||
<summary>
|
||
Merges a sequence of <see cref="T:Mscc.GenerativeAI.Types.GenerateContentResponse"/> objects into a single one.
|
||
The first candidate of each response is taken; their <see cref="T:Mscc.GenerativeAI.Types.Part"/> collections are
|
||
concatenated in the order the responses are given.
|
||
For duplicated metadata fields the value from the *last* response that provides a
|
||
non-null value overwrites earlier ones (“last value wins”).
|
||
</summary>
|
||
</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(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GeneratedFilesModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GeneratedFilesModel.ListFiles(System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.GuardMimeTypeFileSearchStore(System.String)">
|
||
<summary>
|
||
A comprehensive and complete list of MIME types supported by the
|
||
Gemini API's File Search feature. This list has been verified to
|
||
include all text/x-* types.
|
||
Source: https://ai.google.dev/gemini-api/docs/file-search#supported-files
|
||
</summary>
|
||
</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.GuardInvalidStringsInName(System.String)">
|
||
<summary>
|
||
Checks if invalid characters are part of the name of an entity.
|
||
</summary>
|
||
<param name="value">The name of the URL resource.</param>
|
||
<exception cref="T:System.ArgumentException">Thrown when <see cref="!:value"/> contains invalid characters.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeModelName(System.String)">
|
||
<summary>
|
||
Sanitizes the model name by ensuring it starts with "models/" unless it is a tuned model.
|
||
</summary>
|
||
<param name="value">The model name to sanitize.</param>
|
||
<returns>The sanitized model name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeFileName(System.String)">
|
||
<summary>
|
||
Sanitizes the file name by ensuring it starts with "files/".
|
||
</summary>
|
||
<param name="value">The file name to sanitize.</param>
|
||
<returns>The sanitized file name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeGeneratedFileName(System.String)">
|
||
<summary>
|
||
Sanitizes the generated file name by ensuring it starts with "generatedFiles/".
|
||
</summary>
|
||
<param name="value">The generated file name to sanitize.</param>
|
||
<returns>The sanitized generated file name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeCachedContentName(System.String)">
|
||
<summary>
|
||
Sanitizes the cached content name by ensuring it starts with "cachedContents/".
|
||
</summary>
|
||
<param name="value">The cached content name to sanitize.</param>
|
||
<returns>The sanitized cached content name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeBatchesName(System.String)">
|
||
<summary>
|
||
Sanitizes the batch name by ensuring it starts with "batches/".
|
||
</summary>
|
||
<param name="value">The batch name to sanitize.</param>
|
||
<returns>The sanitized batch name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeTuningJobsName(System.String)">
|
||
<summary>
|
||
Sanitizes the tuning job name by ensuring it starts with "tuningJobs/".
|
||
</summary>
|
||
<param name="value">The tuning job name to sanitize.</param>
|
||
<returns>The sanitized tuning job name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeEndpointName(System.String)">
|
||
<summary>
|
||
Sanitizes the endpoint name.
|
||
</summary>
|
||
<param name="value">The endpoint name to sanitize.</param>
|
||
<returns>The sanitized endpoint name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeFileSearchStoreName(System.String)">
|
||
<summary>
|
||
Sanitizes the file search store name by ensuring it starts with "fileSearchStores/".
|
||
</summary>
|
||
<param name="value">The file search store name to sanitize.</param>
|
||
<returns>The sanitized file search store name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeCorporaName(System.String)">
|
||
<summary>
|
||
Sanitizes the corpora name by ensuring it starts with "corpora/".
|
||
</summary>
|
||
<param name="value">The corpora name to sanitize.</param>
|
||
<returns>The sanitized corpora name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.SanitizeDocumentName(System.String)">
|
||
<summary>
|
||
Sanitizes the document name by ensuring it starts with "documents/".
|
||
</summary>
|
||
<param name="value">The document name to sanitize.</param>
|
||
<returns>The sanitized document name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromBytes(Mscc.GenerativeAI.Types.Part,System.String,System.String)">
|
||
<summary>
|
||
Populates a Part from a byte array string and mime type.
|
||
</summary>
|
||
<param name="part">The part to populate.</param>
|
||
<param name="value">The string representation of the byte array.</param>
|
||
<param name="mimeType">The mime type of the data.</param>
|
||
<returns>The populated part.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromCodeExecutionResult(Mscc.GenerativeAI.Types.Part,System.String,System.String)">
|
||
<summary>
|
||
Populates a Part from a code execution result.
|
||
</summary>
|
||
<param name="part">The part to populate.</param>
|
||
<param name="outcome">The outcome of the code execution.</param>
|
||
<param name="output">The output of the code execution.</param>
|
||
<returns>The populated part.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromExecutableCode(Mscc.GenerativeAI.Types.Part,System.String,Mscc.GenerativeAI.Types.Language)">
|
||
<summary>
|
||
Populates a Part from executable code.
|
||
</summary>
|
||
<param name="part">The part to populate.</param>
|
||
<param name="code">The executable code.</param>
|
||
<param name="language">The language of the code.</param>
|
||
<returns>The populated part.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromFunctionCall(Mscc.GenerativeAI.Types.Part,System.String,System.String[])">
|
||
<summary>
|
||
Populates a Part from a function call.
|
||
</summary>
|
||
<param name="part">The part to populate.</param>
|
||
<param name="name">The name of the function.</param>
|
||
<param name="args">The arguments for the function call.</param>
|
||
<returns>The populated part.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromFunctionResponse(Mscc.GenerativeAI.Types.Part,System.String,System.Object)">
|
||
<summary>
|
||
Populates a Part from a function response.
|
||
</summary>
|
||
<param name="part">The part to populate.</param>
|
||
<param name="name">The name of the function.</param>
|
||
<param name="response">The response from the function.</param>
|
||
<returns>The populated part.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromText(Mscc.GenerativeAI.Types.Part,System.String)">
|
||
<summary>
|
||
Populates a Part from a text string.
|
||
</summary>
|
||
<param name="part">The part to populate.</param>
|
||
<param name="value">The text value.</param>
|
||
<returns>The populated part.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromUri(Mscc.GenerativeAI.Types.Part,System.String,System.String)">
|
||
<summary>
|
||
Populates a Part from a URI.
|
||
</summary>
|
||
<param name="part">The part to populate.</param>
|
||
<param name="uri">The URI of the file data.</param>
|
||
<param name="mimeType">The mime type of the file. If null, it will be inferred from the URI.</param>
|
||
<returns>The populated part.</returns>
|
||
</member>
|
||
<!-- Badly formed XML comment ignored for member "M:Mscc.GenerativeAI.GenerativeAIExtensions.FromVideoMetadata(Mscc.GenerativeAI.Types.Part,System.String,System.String,System.Double)" -->
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.FromFile(System.String,System.String)">
|
||
<summary>
|
||
Creates an Image object from a file URI.
|
||
</summary>
|
||
<param name="uri">The URI of the image file.</param>
|
||
<param name="mimeType">The mime type of the image. If null, it will be inferred from the URI.</param>
|
||
<returns>An Image object.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.IsValidBase64String(System.String)">
|
||
<summary>
|
||
Checks if a string is a valid Base64 string.
|
||
</summary>
|
||
<param name="value">The string to check.</param>
|
||
<returns>True if the string is a valid Base64 string, otherwise false.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.IsValidJson(System.String)">
|
||
<summary>
|
||
Checks if a string is valid JSON.
|
||
</summary>
|
||
<param name="value">The string to check.</param>
|
||
<returns>True if the string is valid JSON, otherwise false.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.EnsureSuccessAsync(System.Net.Http.HttpResponseMessage,System.String,System.Boolean,System.Threading.CancellationToken)">
|
||
<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>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</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.EnsureSuccessAsync(System.Net.Http.HttpResponseMessage,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Throws an exception if the <see cref="P:System.Net.Http.HttpResponseMessage.IsSuccessStatusCode"/> property for the HTTP response is false.
|
||
</summary>
|
||
<param name="response">The HTTP response.</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:Mscc.GenerativeAI.Types.GeminiApiException">The HTTP response was not successful.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.ReadImageFileAsync(System.String)">
|
||
<summary>
|
||
Reads an image file from a URL as a byte array.
|
||
</summary>
|
||
<param name="url">The URL of the image file.</param>
|
||
<returns>A byte array of the image file.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.ReadImageFileAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Reads an image file from a URL as a byte array.
|
||
</summary>
|
||
<param name="url">The URL of the image file.</param>
|
||
<param name="cancellationToken">A cancellation token.</param>
|
||
<returns>A byte array of the image file.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.ReadImageFileBase64Async(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Reads an image file from a URL and returns it as a Base64 encoded string.
|
||
</summary>
|
||
<param name="url">The URL of the image file.</param>
|
||
<param name="cancellationToken">A cancellation token.</param>
|
||
<returns>A Base64 encoded string of the image file.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.GetMimeType(System.String)">
|
||
<summary>
|
||
Gets the MIME type from a file extension in a URI.
|
||
</summary>
|
||
<param name="uri">The URI of the file.</param>
|
||
<returns>The inferred MIME type, or "application/octet-stream" if not found.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="uri"/> is null.</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="M:Mscc.GenerativeAI.GenerativeAIExtensions.GetNormalizedName(System.Delegate)">
|
||
<summary>
|
||
Gets the normalized (snake_case) name of a delegate's method.
|
||
</summary>
|
||
<param name="callback">The delegate to get the name from.</param>
|
||
<returns>The snake_case method name.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.ToFormattedString(System.Net.Http.Headers.HttpHeaders)">
|
||
<summary>
|
||
Converts HTTP headers to a formatted string, redacting sensitive information.
|
||
</summary>
|
||
<param name="headers">The HttpHeaders to format.</param>
|
||
<returns>A formatted string representation of the headers.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.UseJsonMode(Mscc.GenerativeAI.Types.GenerateContentRequest)">
|
||
<inheritdoc cref="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$C15E1AD566BEDE440355D4A0D3457475.UseJsonMode"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.WithTools(Mscc.GenerativeAI.Types.GenerateContentRequest)">
|
||
<inheritdoc cref="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$C15E1AD566BEDE440355D4A0D3457475.WithTools"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.UseGoogleSearch(Mscc.GenerativeAI.Types.Tools)">
|
||
<inheritdoc cref="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseGoogleSearch"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.UseGoogleMaps(Mscc.GenerativeAI.Types.Tools,System.Nullable{System.Boolean})">
|
||
<inheritdoc cref="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseGoogleMaps(System.Nullable{System.Boolean})"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.UseGrounding(Mscc.GenerativeAI.Types.Tools)">
|
||
<inheritdoc cref="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseGrounding"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.UseCodeExecution(Mscc.GenerativeAI.Types.Tools)">
|
||
<inheritdoc cref="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseCodeExecution"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.UseUrlContext(Mscc.GenerativeAI.Types.Tools)">
|
||
<inheritdoc cref="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseUrlContext"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$C15E1AD566BEDE440355D4A0D3457475.UseJsonMode">
|
||
<summary>
|
||
Configures the request to expect a JSON response.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$C15E1AD566BEDE440355D4A0D3457475.WithTools">
|
||
<summary>
|
||
Gets the tools for the request, initializing the collection if it's null.
|
||
</summary>
|
||
<returns>The list of tools for the request.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseGoogleSearch">
|
||
<summary>
|
||
Adds the Google Search tool if it's not already present.
|
||
</summary>
|
||
<returns>The updated list of tools.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseGoogleMaps(System.Nullable{System.Boolean})">
|
||
<summary>
|
||
Adds the Google Maps tool if it's not already present.
|
||
</summary>
|
||
<param name="enableWidget">Whether to enable the widget for Google Maps.</param>
|
||
<returns>The updated list of tools.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseGrounding">
|
||
<summary>
|
||
Adds the Google Search Retrieval tool for grounding if it's not already present.
|
||
</summary>
|
||
<returns>The updated list of tools.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseCodeExecution">
|
||
<summary>
|
||
Adds the Code Execution tool if it's not already present.
|
||
</summary>
|
||
<returns>The updated list of tools.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeAIExtensions.<G>$9552E56704E803DF6E0E60E5B0431C01.UseUrlContext">
|
||
<summary>
|
||
Adds the URL Context tool if it's not already present.
|
||
</summary>
|
||
<returns>The updated list of tools.</returns>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.GenerativeModel">
|
||
<summary>
|
||
Represents a generative model that can be used to generate content, count tokens, and perform other generative AI tasks.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.GenerativeModel._safetySettings">
|
||
<summary>
|
||
Optional. A list of unique SafetySetting instances for blocking unsafe content.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.GenerativeModel._generationConfig">
|
||
<summary>
|
||
Optional. Configuration options for model generation and outputs.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.GenerativeModel._tools">
|
||
<summary>
|
||
Optional. A list of Tools the model may use to generate the next response.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.GenerativeModel._toolConfig">
|
||
<summary>
|
||
Optional. Configuration of tools used by the model.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Mscc.GenerativeAI.GenerativeModel._systemInstruction">
|
||
<summary>
|
||
Optional. Instructions for the model to steer it toward better performance.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.Url">
|
||
<summary>
|
||
Gets the appropriate API URL based on the configuration (Google AI vs. Vertex AI, custom endpoint, etc.).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.Version">
|
||
<summary>
|
||
Gets or sets the API version. For Vertex AI, this is fixed to v1.
|
||
</summary>
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.Method">
|
||
<summary>
|
||
Determines the API method name based on the model and configuration.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.IsVertexAI">
|
||
<summary>
|
||
Gets a value indicating whether the model is configured to use Vertex AI.
|
||
</summary>
|
||
</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>
|
||
Gets or sets a value indicating whether to activate JSON Mode, which instructs the model to generate a JSON object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseGrounding">
|
||
<summary>
|
||
Gets or sets a value indicating whether to activate grounding with Google Search, which connects the model to real-time information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseGoogleSearch">
|
||
<summary>
|
||
Gets or sets a value indicating whether to activate the Google Search tool, allowing the model to query Google Search.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseCodeExecution">
|
||
<summary>
|
||
Gets or sets a value indicating whether to activate automatic code execution, allowing the model to run code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.GenerativeModel.UseRealtime">
|
||
<summary>
|
||
Gets or sets a value indicating whether to enable a realtime stream using the 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.
|
||
The default constructor attempts to read `.env` file and environment variables to set default values.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class with specified HTTP client factory and logger.
|
||
The default constructor attempts to read <c>.env</c> file and environment variables.
|
||
Sets default values, if available.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(System.String,System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Mscc.GenerativeAI.Types.ToolConfig,System.Boolean,System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class for use with Google AI, with optional express Vertex AI configuration.
|
||
</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="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</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,System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Mscc.GenerativeAI.Types.ToolConfig,System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class for use with Vertex AI.
|
||
</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="accessToken">Access token for the Google Cloud project.</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="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.#ctor(Mscc.GenerativeAI.Types.CachedContent,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class from a <see cref="T:Mscc.GenerativeAI.Types.CachedContent"/> object.
|
||
</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="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</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.Types.TuningJob,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class from a <see cref="T:Mscc.GenerativeAI.Types.TuningJob"/> object.
|
||
</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="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</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.#ctor(System.Net.Http.HttpMessageHandler,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.GenerativeModel"/> class for testing purposes, allowing injection of a custom <see cref="T:System.Net.Http.HttpMessageHandler"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.ListTunedModels(System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets a list of available tuned models and their descriptions.
|
||
</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="returnPartialSuccess">When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.</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>
|
||
<exception cref="T:System.NotSupportedException"></exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.ListModels(System.Boolean,System.Nullable{System.Int32},System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>
|
||
<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,Mscc.GenerativeAI.Types.RequestOptions,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="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></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.Types.CopyModelRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Copies a model in Vertex AI Model Registry.
|
||
</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></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.Types.CreateTunedModelRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a tuned model.
|
||
</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></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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.ModelResponse,System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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></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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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,Mscc.GenerativeAI.Types.RequestOptions,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="requestOptions">Options for the request.</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.Types.MaxUploadFileSizeException">Thrown when the file size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.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,Mscc.GenerativeAI.Types.RequestOptions,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="requestOptions">Options for the request.</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.Types.MaxUploadFileSizeException">Thrown when the <paramref name="stream"/> size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates a model response given an input <see cref="T:Mscc.GenerativeAI.Types.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.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.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.Types.IPart},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContentStream(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.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.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContentStream(System.Collections.Generic.List{Mscc.GenerativeAI.Types.IPart},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.ToolConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateContentStreamSSE(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.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.BatchEmbedContent(Mscc.GenerativeAI.Types.AsyncBatchEmbedContentRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Enqueues a batch of <see cref="M:Mscc.GenerativeAI.GenerativeModel.EmbedContent(Mscc.GenerativeAI.Types.EmbedContentRequest,System.String,System.Nullable{Mscc.GenerativeAI.Types.TaskType},System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)"/> requests for batch processing.
|
||
</summary>
|
||
<remarks>
|
||
We have a `BatchEmbedContents` handler in `GenerativeService`, but it was synchronized.
|
||
So we name this one to be `Async` to avoid confusion.
|
||
</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.BatchGenerateContent(Mscc.GenerativeAI.Types.BatchGenerateContentRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Enqueues a batch of <see cref="M:Mscc.GenerativeAI.GenerativeModel.GenerateContent(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)"/> requests for batch processing.
|
||
</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.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.Types.GenerateImagesRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<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></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.GenerateImages(System.String,System.String,Mscc.GenerativeAI.Types.GenerateImagesConfig,Mscc.GenerativeAI.Types.RequestOptions,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="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="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.Nullable{Mscc.GenerativeAI.Types.ImageAspectRatio},System.Nullable{System.Int32},System.Nullable{Mscc.GenerativeAI.Types.ImagePromptLanguage},System.Nullable{Mscc.GenerativeAI.Types.SafetyFilterLevel},System.Nullable{Mscc.GenerativeAI.Types.PersonGeneration},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.RequestOptions,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="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.EditImage(Mscc.GenerativeAI.Types.EditImageRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Edits a set of images specified in the request.
|
||
</summary>
|
||
<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></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 or combination of features.</exception>
|
||
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.EditImage(System.String,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ReferenceImage},System.Int32,Mscc.GenerativeAI.Types.EditImageConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Edits a set of images based on a text description and configuration.
|
||
</summary>
|
||
<param name="model">Required. Model to use.</param>
|
||
<param name="prompt">Required. A text description of the edit to apply to the image.</param>
|
||
<param name="images">List of references images for editing.</param>
|
||
<param name="numberOfImages">Number of images to generate. Range: 1..8.</param>
|
||
<param name="config">Configuration for image editing.</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></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.UpscaleImage(Mscc.GenerativeAI.Types.UpscaleImageRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Makes an API request to upscale a provided image.
|
||
</summary>
|
||
<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></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 or combination of features.</exception>
|
||
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.UpscaleImage(System.String,Mscc.GenerativeAI.Types.Image,System.Nullable{Mscc.GenerativeAI.Types.UpscaleFactor},Mscc.GenerativeAI.Types.UpscaleImageConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Makes an API request to upscale a provided image.
|
||
</summary>
|
||
<param name="model">The model to use.</param>
|
||
<param name="image">The input image for upscaling.</param>
|
||
<param name="upscaleFactor">The factor to upscale the image (x2 or x4).</param>
|
||
<param name="config">Configuration for upscaling.</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></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="image"/> 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.GenerateVideos(Mscc.GenerativeAI.Types.GenerateVideosRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates a video response from the model given an input <see cref="T:Mscc.GenerativeAI.Types.GenerateVideosRequest"/>.
|
||
</summary>
|
||
<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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateVideos(System.String,System.String,Mscc.GenerativeAI.Types.GenerateVideosConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="model"></param>
|
||
<param name="prompt"></param>
|
||
<param name="config"></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></returns>
|
||
<exception cref="T:System.ArgumentNullException"></exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateVideos(System.String,System.Int32,System.String,System.Nullable{Mscc.GenerativeAI.Types.ImageAspectRatio},System.Nullable{System.Int32},System.Nullable{Mscc.GenerativeAI.Types.ImagePromptLanguage},System.Nullable{Mscc.GenerativeAI.Types.SafetyFilterLevel},System.Nullable{Mscc.GenerativeAI.Types.PersonGeneration},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.RequestOptions,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="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.GenerateAnswer(Mscc.GenerativeAI.Types.GenerateAnswerRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates a grounded answer from the model given an input GenerateAnswerRequest.
|
||
</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>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>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateAnswer(System.String,System.Nullable{Mscc.GenerativeAI.Types.AnswerStyle},System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedContent(Mscc.GenerativeAI.Types.EmbedContentRequest,System.String,System.Nullable{Mscc.GenerativeAI.Types.TaskType},System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.EmbedContentRequest},System.String,System.Nullable{Mscc.GenerativeAI.Types.TaskType},System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.TaskType},System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.TaskType},System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.ContentResponse,System.String,System.Nullable{Mscc.GenerativeAI.Types.TaskType},System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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>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(System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.Content},Mscc.GenerativeAI.Types.CountTokensConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Counts the number of tokens for the given content.
|
||
</summary>
|
||
<param name="model">The name of the GenAI model to use for token counting.</param>
|
||
<param name="contents">A <see cref="T:System.Collections.Generic.List`1"/> to compute tokens for.</param>
|
||
<param name="config">A <see cref="T:Mscc.GenerativeAI.Types.CountTokensConfig"/> instance that specifies the optional configurations.</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>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous operation. The task result contains a <see
|
||
cref="T:Mscc.GenerativeAI.Types.CountTokensResponse"/> instance with token information.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.Types.GenerateContentRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Counts the number of tokens for the given content.
|
||
</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>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous operation. The task result contains a <see
|
||
cref="T:Mscc.GenerativeAI.Types.CountTokensResponse"/> instance with token information.</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.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(System.Collections.Generic.List{Mscc.GenerativeAI.Types.IPart},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.Types.FileResource,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Counts the number of tokens for the given file resource.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.ComputeTokens(System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.Content},Mscc.GenerativeAI.Types.ComputeTokensConfig,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Computes the number of tokens for the given content.
|
||
</summary>
|
||
<param name="model">The name of the GenAI model to use for token computation.</param>
|
||
<param name="contents">A <see cref="T:System.Collections.Generic.List`1"/> to compute tokens for.</param>
|
||
<param name="config">A <see cref="T:Mscc.GenerativeAI.Types.ComputeTokensConfig"/> instance that specifies the optional configurations.</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>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous operation. The task result contains a <see
|
||
cref="T:Mscc.GenerativeAI.Types.ComputeTokensResponse"/> instance with token information.</returns>
|
||
<exception cref="T:System.NotSupportedException">Thrown when called with a non-Vertex AI client.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.ComputeTokens(Mscc.GenerativeAI.Types.ComputeTokensRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Computes the number of tokens for the given 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>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous operation. The task result contains a <see
|
||
cref="T:Mscc.GenerativeAI.Types.ComputeTokensResponse"/> instance with token information.</returns>
|
||
<exception cref="T:System.NotSupportedException">Thrown when called with a non-Vertex AI client.</exception>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when request is null.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.StartChat(System.Collections.Generic.List{Mscc.GenerativeAI.Types.ContentResponse},Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,System.Boolean)">
|
||
<summary>
|
||
Starts a chat session.
|
||
</summary>
|
||
<param name="history">Optional. A collection of <see cref="T:Mscc.GenerativeAI.Types.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.Types.ChatSession"/> attached to this model.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.Predict(Mscc.GenerativeAI.Types.PredictRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Performs a prediction request.
|
||
</summary>
|
||
<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>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.Types.PredictLongRunningRequest,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.GenerateTextRequest,Mscc.GenerativeAI.Types.RequestOptions,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="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></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.GenerateText(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.Types.GenerateTextRequest,Mscc.GenerativeAI.Types.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.Types.GenerateMessageRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates a response from the model given an input prompt.
|
||
</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></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,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.Types.GenerateMessageRequest,Mscc.GenerativeAI.Types.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.Types.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>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.EmbedText(System.String,System.Threading.CancellationToken)">
|
||
<remarks/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GenerativeModel.CountTokens(Mscc.GenerativeAI.Types.EmbedTextRequest,Mscc.GenerativeAI.Types.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.Types.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>
|
||
</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(System.Net.Http.IHttpClientFactory,Mscc.GenerativeAI.Types.RequestOptions,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>
|
||
<param name="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="requestOptions">Optional. Options for the request.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<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,System.Net.Http.IHttpClientFactory,Mscc.GenerativeAI.Types.RequestOptions,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="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="requestOptions">Optional. Options for the request.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.GenerativeModel(System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Create a generative model on Google AI to use.
|
||
</summary>
|
||
<param name="model">Model to use (default: "gemini-2.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>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<returns>Generative model instance.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.GenerativeModel(Mscc.GenerativeAI.Types.CachedContent,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Microsoft.Extensions.Logging.ILogger)">
|
||
<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>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<returns>Generative model instance.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="cachedContent"/> is null.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.GetModel(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<inheritdoc cref="T:Mscc.GenerativeAI.IGenerativeAI"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.CachedContent(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Returns an instance of <see cref="T:Mscc.GenerativeAI.CachedContentModel"/> to use with a model.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<returns>Cached content instance.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.Batches(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Returns an instance of <see cref="T:Mscc.GenerativeAI.BatchesModel"/> to use with a model.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<returns>Batches instance.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.ImageGenerationModel(System.String,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Returns an instance of <see cref="M:Mscc.GenerativeAI.GoogleAI.ImageGenerationModel(System.String,Microsoft.Extensions.Logging.ILogger)"/> to use with a model.
|
||
</summary>
|
||
<param name="model">Model to use (default: "imagegeneration")</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<returns>Imagen model</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.FileSearchStoresModel">
|
||
<summary>
|
||
Returns an instance of <see cref="M:Mscc.GenerativeAI.GoogleAI.FileSearchStoresModel"/>.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.OperationsModel">
|
||
<summary>
|
||
Returns an instance of <see cref="M:Mscc.GenerativeAI.GoogleAI.OperationsModel"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.UploadFile(System.String,System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,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="requestOptions">Options for the request.</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.Types.MaxUploadFileSizeException">Thrown when the file size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.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,Mscc.GenerativeAI.Types.RequestOptions,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="requestOptions">Options for the request.</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.Types.MaxUploadFileSizeException">Thrown when the <paramref name="stream"/> size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.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,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<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>
|
||
<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>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,Mscc.GenerativeAI.Types.RequestOptions,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 files.list call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</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>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,Mscc.GenerativeAI.Types.RequestOptions,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 files.list method. Format: files/file-id.</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>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,Mscc.GenerativeAI.Types.RequestOptions,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 files.list method. Format: files/file-id.</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>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.RegisterFiles(System.Collections.Generic.List{System.String},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Registers a Google Cloud Storage files with FileService.
|
||
The user is expected to provide Google Cloud Storage URIs and will receive a File resource
|
||
for each URI in return. Note that the files are not copied, just registered with File API.
|
||
If one file fails to register, the whole request fails.
|
||
</summary>
|
||
<param name="gcsUris">List of Google Cloud Storage URIs to register.</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.GoogleAI.ListGeneratedFiles(System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,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 files.list call. Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.</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>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.Guard">
|
||
<summary>
|
||
|
||
</summary>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when both "apiKey" and "accessToken" are <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.HttpRequestExtensions">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.HttpRequestExtensions.SetTimeout(System.Net.Http.HttpRequestMessage,System.Nullable{System.TimeSpan})">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="request"></param>
|
||
<param name="timeout"></param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.HttpRequestExtensions.GetTimeout(System.Net.Http.HttpRequestMessage)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="request"></param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.HttpRequestExtensions.AddApiKeyHeader(System.Net.Http.HttpRequestMessage,System.String)">
|
||
<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>
|
||
<param name="apiKey">The API key to use for the request.</param>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.HttpRequestTimeoutHandler">
|
||
<summary>
|
||
A delegating handler that provides a timeout for HTTP requests.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.HttpRequestTimeoutHandler.#ctor">
|
||
<summary>
|
||
Default constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.HttpRequestTimeoutHandler.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Base constructor to set the <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.HttpRequestTimeoutHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="request"></param>
|
||
<param name="cancellationToken"></param>
|
||
<returns></returns>
|
||
<exception cref="T:System.TimeoutException"></exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.HttpRequestTimeoutHandler.GetCancellationTokenSource(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="request"></param>
|
||
<param name="cancellationToken"></param>
|
||
<returns></returns>
|
||
</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.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Microsoft.Extensions.Logging.ILogger)">
|
||
<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>
|
||
<param name="logger">Optional. Logger instance used for logging</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.Types.CachedContent,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Microsoft.Extensions.Logging.ILogger)">
|
||
<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>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<returns>Generative model instance.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.IGenerativeAI.GetModel(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<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>
|
||
<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></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,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Returns an instance of an image generation model.
|
||
</summary>
|
||
<param name="model">Model to use (default: "imagegeneration")</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.IGenerativeAI.FileSearchStoresModel">
|
||
<summary>
|
||
Returns an instance of <see cref="M:Mscc.GenerativeAI.IGenerativeAI.FileSearchStoresModel"/>.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.IGenerativeAI.OperationsModel">
|
||
<summary>
|
||
Returns an instance of <see cref="M:Mscc.GenerativeAI.IGenerativeAI.OperationsModel"/>.
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging</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(System.Net.Http.IHttpClientFactory,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>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ImageGenerationModel.#ctor(System.String,System.String,System.Net.Http.IHttpClientFactory,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="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</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,System.String,System.Net.Http.IHttpClientFactory,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="accessToken">Access token for the Google Cloud project.</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.Types.ImageGenerationRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates images from the specified <see cref="T:Mscc.GenerativeAI.Types.ImageGenerationRequest"/>.
|
||
</summary>
|
||
<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 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.Nullable{Mscc.GenerativeAI.Types.ImageAspectRatio},System.Nullable{System.Int32},System.Nullable{Mscc.GenerativeAI.Types.ImagePromptLanguage},System.Nullable{Mscc.GenerativeAI.Types.SafetyFilterLevel},System.Nullable{Mscc.GenerativeAI.Types.PersonGeneration},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.RequestOptions,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="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.ImageGenerationModel.GenerateContent(System.String,Mscc.GenerativeAI.Types.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="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="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(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.ImagesModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ImagesModel.Images(Mscc.GenerativeAI.Types.ImagesGenerationsRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</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></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(System.Net.Http.IHttpClientFactory,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>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ImageTextModel.#ctor(System.String,System.String,System.String,System.String,System.Net.Http.IHttpClientFactory,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="accessToken">Access token for the Google Cloud project.</param>
|
||
<param name="model">Model to use</param>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ImageTextModel.GetCaptions(Mscc.GenerativeAI.Types.ImageTextRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates images from the specified <see cref="T:Mscc.GenerativeAI.Types.ImageTextRequest"/>.
|
||
</summary>
|
||
<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 images.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.ImageTextModel.GetCaptions(System.String,System.Nullable{System.Int32},System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,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="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="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,Mscc.GenerativeAI.Types.RequestOptions,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="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="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="T:Mscc.GenerativeAI.InteractionsModel">
|
||
<summary>
|
||
The Gemini Interactions API is an experimental API that allows developers to build generative AI applications using Gemini models.
|
||
Gemini is a highly capable multimodal model that can understand and process various types of information, including language, images, audio, video, and code.
|
||
The API supports use cases like reasoning across text and images, content generation, dialogue agents, summarization, and classification.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.InteractionsModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.#ctor(System.Net.Http.IHttpClientFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.InteractionsModel"/> class with a specified <see cref="T:System.Net.Http.IHttpClientFactory"/>.
|
||
</summary>
|
||
<param name="apiClient">The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for making API requests.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.InteractionsModel"/> class with optional <see cref="T:System.Net.Http.IHttpClientFactory"/> and <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance for logging.</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Create(Mscc.GenerativeAI.Types.InteractionRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction based on the provided request.
|
||
</summary>
|
||
<param name="request">The request object containing all parameters for the interaction.</param>
|
||
<param name="requestOptions">Optional. Options for configuring the request, such as timeout and retry settings.</param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>An <see cref="T:Mscc.GenerativeAI.Types.InteractionResource"/> representing the created interaction.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown if the request is null.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Create(System.String,System.String,System.String,System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction with the specified parameters.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">The input string for the interaction.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An <see cref="T:Mscc.GenerativeAI.Types.InteractionResource"/> representing the created interaction.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Create(System.String,System.String,Mscc.GenerativeAI.Types.InteractionContent,System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction with the specified parameters, using structured content as input.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">The structured content for the interaction.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An <see cref="T:Mscc.GenerativeAI.Types.InteractionResource"/> representing the created interaction.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Create(System.String,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.InteractionContent},System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction with a list of content parts as input.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">A list of content parts for the interaction.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An <see cref="T:Mscc.GenerativeAI.Types.InteractionResource"/> representing the created interaction.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Create(System.String,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.InteractionTurn},System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction with a history of conversation turns as input.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">A list of conversation turns representing the history.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An <see cref="T:Mscc.GenerativeAI.Types.InteractionResource"/> representing the created interaction.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.CreateStream(Mscc.GenerativeAI.Types.InteractionRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction and streams the response as it is generated.
|
||
</summary>
|
||
<param name="request">The request object containing all parameters for the interaction.</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An asynchronous stream of <see cref="T:Mscc.GenerativeAI.Types.InteractionSseEvent"/> chunks.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown if the request is null.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.CreateStream(System.String,System.String,System.String,System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction and streams the response.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">The input string for the interaction.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An asynchronous stream of <see cref="T:Mscc.GenerativeAI.Types.InteractionSseEvent"/> chunks.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.CreateStream(System.String,System.String,Mscc.GenerativeAI.Types.InteractionContent,System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction with structured content and streams the response.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">The structured content for the interaction.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An asynchronous stream of <see cref="T:Mscc.GenerativeAI.Types.InteractionSseEvent"/> chunks.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.CreateStream(System.String,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.InteractionContent},System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction with a list of content parts and streams the response.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">A list of content parts for the interaction.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An asynchronous stream of <see cref="T:Mscc.GenerativeAI.Types.InteractionSseEvent"/> chunks.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.CreateStream(System.String,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.InteractionTurn},System.String,Mscc.GenerativeAI.Types.InteractionTools,System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.GenerationConfig,System.Object,System.String,System.Collections.Generic.List{Mscc.GenerativeAI.Types.ResponseModality},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates a new interaction with a history of conversation turns and streams the response.
|
||
</summary>
|
||
<param name="model">The name of the `Model` to use for the interaction.</param>
|
||
<param name="agent">The name of the `Agent` to use for the interaction.</param>
|
||
<param name="input">A list of conversation turns representing the history.</param>
|
||
<param name="systemInstruction">A system instruction to guide the model's behavior.</param>
|
||
<param name="tools">A list of tool declarations the model may call.</param>
|
||
<param name="responseFormat">Enforces the response to be a JSON object matching a specified schema.</param>
|
||
<param name="responseMimeType">The MIME type of the response, required if `responseFormat` is set.</param>
|
||
<param name="stream">If true, the interaction will be streamed.</param>
|
||
<param name="store">If true, the request and response will be stored for later retrieval.</param>
|
||
<param name="background">If true, the interaction will run in the background.</param>
|
||
<param name="generationConfig">Configuration for the model's generation process.</param>
|
||
<param name="agentConfig">Configuration for the agent.</param>
|
||
<param name="previousInteractionId">The ID of the previous interaction in a conversation.</param>
|
||
<param name="responseModalities">The requested modalities for the response (e.g., TEXT, IMAGE).</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An asynchronous stream of <see cref="T:Mscc.GenerativeAI.Types.InteractionSseEvent"/> chunks.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Get(System.String,System.Nullable{System.Boolean},System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Retrieves the full details of a single interaction by its ID.
|
||
</summary>
|
||
<param name="id">The unique identifier of the interaction to retrieve.</param>
|
||
<param name="stream">If true, the generated content will be streamed incrementally.</param>
|
||
<param name="lastEventId">Optional. If set, resumes the stream from the event after the specified ID. Requires `stream` to be true.</param>
|
||
<param name="apiVersion">The API version to use for the request.</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An <see cref="T:Mscc.GenerativeAI.Types.InteractionResource"/> with the details of the interaction.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Delete(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes an interaction by its ID.
|
||
</summary>
|
||
<param name="id">The unique identifier of the interaction to delete.</param>
|
||
<param name="apiVersion">The API version to use for the request.</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An empty string if the deletion is successful.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.InteractionsModel.Cancel(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Cancels a running background interaction by its ID.
|
||
</summary>
|
||
<param name="id">The unique identifier of the interaction to cancel.</param>
|
||
<param name="apiVersion">The API version to use for the request.</param>
|
||
<param name="requestOptions">Optional. Options for configuring 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>An <see cref="T:Mscc.GenerativeAI.Types.InteractionResource"/> representing the canceled interaction.</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.MediaModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.MediaModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.MediaModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.MediaModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The IHttpClientFactory to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.MediaModel.UploadToRagStore(System.String,System.String,System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Uploads data to a ragStore, preprocesses and chunks before storing it in a RagStore Document.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.MediaModel.UploadToFileSearchStore(System.String,System.String,System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Uploads data to a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/>, preprocesses and chunks before storing it in a <see cref="T:Mscc.GenerativeAI.Types.FileSearchStore"/> Document.
|
||
</summary>
|
||
<param name="fileSearchStoreName">Name of the File Search Store.</param>
|
||
<param name="file">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="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>An operation of the uploaded file.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="file"/> is null or empty.</exception>
|
||
<exception cref="T:System.IO.FileNotFoundException">Thrown when the file <paramref name="file"/> is not found.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.MaxUploadFileSizeException">Thrown when the file size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.UploadFileException">Thrown when the file upload fails.</exception>
|
||
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the MIME type of the URI is not supported by the API.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.MediaModel.UploadFile(System.String,System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.MaxUploadFileSizeException">Thrown when the file size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.UploadFileException">Thrown when the file upload fails.</exception>
|
||
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the MIME type of the URI is not supported by the API.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.MediaModel.UploadFile(System.IO.Stream,System.String,System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,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="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>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.Types.MaxUploadFileSizeException">Thrown when the <paramref name="stream"/> size exceeds the maximum allowed size.</exception>
|
||
<exception cref="T:Mscc.GenerativeAI.Types.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>
|
||
<exception cref="T:System.NotSupportedException">Thrown when the <paramref name="mimeType"/> is not supported by the API.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.MediaModel.Download(System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<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>
|
||
<param name="media">Optional. Flag indicating whether to retrieve the file content.</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>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.MediaModel.DownloadFile(System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<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>
|
||
<param name="media">Optional. Flag indicating whether to retrieve the file content.</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>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.OpenAIModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.OpenAIModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OpenAIModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.OpenAIModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OpenAIModel.ListModels(Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Lists the currently available models.
|
||
</summary>
|
||
<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>List of available models.</returns>
|
||
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OpenAIModel.GetModel(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets a model instance.
|
||
</summary>
|
||
<param name="modelsId">Required. The resource name of the model. This name should match a model name returned by the ListModels method.</param>
|
||
<param name="model">Required. The name of the model to get.</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></returns>
|
||
<exception cref="T:System.Net.Http.HttpRequestException">Thrown when the request fails to execute.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OpenAIModel.Completions(Mscc.GenerativeAI.Types.ChatCompletionsRequest,Mscc.GenerativeAI.Types.RequestOptions,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="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>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OpenAIModel.Embeddings(Mscc.GenerativeAI.Types.GenerateEmbeddingsRequest,Mscc.GenerativeAI.Types.RequestOptions,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="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>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OpenAIModel.Images(Mscc.GenerativeAI.Types.ImagesGenerationsRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</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></returns>
|
||
<exception cref="T:System.ArgumentNullException"></exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OperationsModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.OperationsModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OperationsModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.OperationsModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.OperationsModel.Get``2(``0,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest state of a long-running operation.
|
||
Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
||
</summary>
|
||
<param name="operation"></param>
|
||
<param name="token"></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>
|
||
<typeparam name="T"></typeparam>
|
||
<returns></returns>
|
||
<exception cref="T:System.ArgumentNullException"></exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.RagEngineModel">
|
||
<summary>
|
||
The `RagEngineModel` class provides methods for interacting with a RAG engine.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.RagEngineModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.RagEngineModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.#ctor(System.String,System.String,System.String,System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Mscc.GenerativeAI.Types.ToolConfig,System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.RagEngineModel"/> class.
|
||
</summary>
|
||
<param name="projectId"></param>
|
||
<param name="region"></param>
|
||
<param name="accessToken">Access token for the Google Cloud project.</param>
|
||
<param name="model"></param>
|
||
<param name="generationConfig"></param>
|
||
<param name="safetySettings"></param>
|
||
<param name="tools"></param>
|
||
<param name="systemInstruction"></param>
|
||
<param name="toolConfig"></param>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.Create(Mscc.GenerativeAI.Types.RagCorpus,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates an empty `RAG Corpus`.
|
||
</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.Update(System.String,Mscc.GenerativeAI.Types.RagCorpus,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates a `RAG Corpus`.
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="corpus"></param>
|
||
<param name="updateMask"></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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.List(System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Lists all `RAG Corpora` owned by the user.
|
||
</summary>
|
||
<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="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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.Get(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets information about a specific `RAG Corpus`.
|
||
</summary>
|
||
<param name="name"></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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.Delete(System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes a `RAG Corpus`.
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="force"></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>DeleteOperationMetadata</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.UploadFile(System.String,System.String,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Upload a local file to the corpus.
|
||
</summary>
|
||
<param name="name"></param>
|
||
<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="description"></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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.UploadFile(System.String,System.IO.Stream,System.String,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Upload a stream to the corpus.
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="stream">Stream to upload.</param>
|
||
<param name="mimeType">The MIME type of the stream content.</param>
|
||
<param name="displayName">A name displayed for the uploaded file.</param>
|
||
<param name="description"></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></returns>
|
||
<exception cref="T:System.ArgumentNullException"></exception>
|
||
<exception cref="T:System.ArgumentException"></exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.ImportFiles(System.String,System.String[],Mscc.GenerativeAI.Types.TransformationConfig,System.Nullable{System.Int32},System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="uris"></param>
|
||
<param name="transformationConfig"></param>
|
||
<param name="maxEmbeddingRequestsPerMin"></param>
|
||
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
|
||
<returns>ImportRagFilesOperationMetadata</returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.ListFiles(System.String,System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="name"></param>
|
||
<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="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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.GetFile(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="fileName"></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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.DeleteFile(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="name"></param>
|
||
<param name="fileName"></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></returns>
|
||
<exception cref="T:System.ArgumentNullException"></exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.RetrievalQuery(Mscc.GenerativeAI.RagRetrievalQueryRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagEngineModel.RetrievalQuery(System.Collections.Generic.List{Mscc.GenerativeAI.Types.VertexRagStoreRagResource},System.String,Mscc.GenerativeAI.Types.RagRetrievalConfig,System.Nullable{System.Single},System.Nullable{System.Int32},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="ragResources"></param>
|
||
<param name="text"></param>
|
||
<param name="ragRetrievalConfig"></param>
|
||
<param name="vectorDistanceThreshold"></param>
|
||
<param name="similarityTopK"></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></returns>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.RagRetrievalQueryRequest">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.RagRetrievalQueryRequest.Query">
|
||
<summary>
|
||
Required. Single RAG retrieve query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.RagRetrievalQueryRequest.VertexRagStore">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.RagQueryRequest.Query">
|
||
<summary>
|
||
Required. Single RAG retrieve query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.RagQueryRequest.DataSource">
|
||
<summary>
|
||
The data source for Vertex RagStore.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.RagContexts">
|
||
<summary>
|
||
Relevant contexts for one query.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.Context">
|
||
<summary>
|
||
A context of the query.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Context.SourceUri">
|
||
<summary>
|
||
If the file is imported from Cloud Storage or Google Drive,
|
||
sourceUri will be original file URI in Cloud Storage or Google Drive;
|
||
if file is uploaded, sourceUri will be file display name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Context.SourceDisplayName">
|
||
<summary>
|
||
The file display name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Context.Text">
|
||
<summary>
|
||
The text chunk.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.Context.Score">
|
||
<summary>
|
||
According to the underlying Vector DB and the selected metric type,
|
||
the score can be either the distance or the similarity between the query
|
||
and the context and its range depends on the metric type.
|
||
</summary>
|
||
<remarks>
|
||
For example, if the metric type is COSINE_DISTANCE, it represents the distance
|
||
between the query and the context. The larger the distance, the less relevant
|
||
the context is to the query.
|
||
The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagStoresModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.RagStoresModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagStoresModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.RagStoresModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagStoresModel.Create(Mscc.GenerativeAI.Types.Document,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Creates an empty <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="request">Required. The `Document`.</param>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where this `Document` will be created. Example: `ragStores/my-rag-store-123`</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> 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.RagStoresModel.Delete(System.String,System.String,System.Boolean,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes a <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where this `Document` exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="documentsId">Required. The name of the `Document`.</param>
|
||
<param name="force">Optional. If set to true, any `Chunk`s and objects related to this `Document` will also be deleted. If false (the default), a `FAILED_PRECONDITION` error will be returned if `Document` contains any `Chunk`s.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="documentsId"/> 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.RagStoresModel.Get(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets information about a specific <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where this `Document` exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="documentsId">Required. The name of the `Document`.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="documentsId"/> 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.RagStoresModel.List(System.String,System.Nullable{System.Int32},System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Lists all <see cref="T:Mscc.GenerativeAI.Types.Document"/>s in a `RagStores`.
|
||
</summary>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where the `Document`s exist. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="pageSize"></param>
|
||
<param name="pageToken"></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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> 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.RagStoresModel.Patch(System.String,Mscc.GenerativeAI.Types.RagStore,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Updates a `RagStore`.
|
||
</summary>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where the `Document`s exist. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="ragStore"></param>
|
||
<param name="updateMask">Optional. The list of fields to update.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.RagStoresModel.Query(Mscc.GenerativeAI.Types.QueryDocumentRequest,System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Performs semantic search over a <see cref="T:Mscc.GenerativeAI.Types.Document"/>.
|
||
</summary>
|
||
<param name="request"></param>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where this `Document` exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="documentsId">Required. The name of the `Document`.</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></returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="documentsId"/> 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.RagStoresModel.GetOperation(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
||
</summary>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where this `Operation` exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="operationsId">Required. The name of the `Operation`.</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>Metadata for the given file.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="operationsId"/> 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.RagStoresModel.GetUpload(System.String,System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
||
</summary>
|
||
<param name="ragStoresId">Required. The name of the `RagStore` where this `Operation` exists. Example: `ragStores/my-rag-store-123`</param>
|
||
<param name="operationsId">Required. The name of the `Operation`.</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>Metadata for the given file.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="ragStoresId"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="operationsId"/> 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="T:Mscc.GenerativeAI.SdkModel">
|
||
<summary>
|
||
The model object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.SdkModel.Id">
|
||
<summary>
|
||
Output only. Id of the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.SdkModel.Object">
|
||
<summary>
|
||
Output only. Always "model", required by the SDK.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.SdkModel.Created">
|
||
<summary>
|
||
Output only. The Unix timestamp (in seconds) when the model was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.SdkModel.OwnedBy">
|
||
<summary>
|
||
Output only. The organization that owns the model.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.SdkModel.Deleted">
|
||
<summary>
|
||
Output only. Optional. An indicator whether a fine-tuned model has been deleted.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.SupervisedTuningJobModel">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.SupervisedTuningJobModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.SupervisedTuningJobModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.#ctor(System.String,System.String,System.String,System.String,System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.SupervisedTuningJobModel"/> 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="accessToken">Access token for the Google Cloud project.</param>
|
||
<param name="model">Model to use</param>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.Create(Mscc.GenerativeAI.Types.CreateTuningJobRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</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></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when the <paramref name="request"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.List(Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<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></returns>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.Get(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets metadata of a tuning job.
|
||
</summary>
|
||
<param name="tuningJobId">Required. The ID of the tuning job. Format: `tuningJobs/{id}`</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>The details of a tuning job.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="tuningJobId"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.Cancel(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Cancels a tuning job.
|
||
</summary>
|
||
<param name="tuningJobId">Required. The ID of the tuning job. Format: `tuningJobs/{id}`</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>If successful, the response body is empty.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="tuningJobId"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.SupervisedTuningJobModel.Delete(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Deletes a tuning job.
|
||
</summary>
|
||
<param name="tuningJobId">Required. The ID of the tuning job. Format: `tuningJobs/{id}`</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>If successful, the response body is empty.</returns>
|
||
<exception cref="T:System.ArgumentException">Thrown when the <paramref name="tuningJobId"/> is <see langword="null"/> or empty.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.TunedModel">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.TunedModel.Model">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.TunedModel.Endpoint">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.ElasticSearchParams">
|
||
<summary>
|
||
The search parameters to use for the ELASTIC_SEARCH spec.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.ElasticSearchParams.Index">
|
||
<summary>
|
||
The ElasticSearch index to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.ElasticSearchParams.NumHits">
|
||
<summary>
|
||
Optional. Number of hits (chunks) to request.
|
||
When specified, it is passed to Elasticsearch as the `num_hits` param.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Mscc.GenerativeAI.ElasticSearchParams.SearchTemplate">
|
||
<summary>
|
||
The ElasticSearch search template to use.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.SimpleSearchParams">
|
||
<summary>
|
||
The search parameters to use for SIMPLE_SEARCH spec.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.ToolCodeExecution">
|
||
<summary>
|
||
Tool that executes code generated by the model, and
|
||
automatically returns the result to the model.
|
||
</summary>
|
||
<remarks>
|
||
See also `<see cref="T:Mscc.GenerativeAI.Types.ExecutableCode"/>` and `<see cref="T:Mscc.GenerativeAI.Types.CodeExecutionResult"/>`
|
||
which are only generated when using this tool.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.VertexAI">
|
||
<summary>
|
||
Entry point to access Gemini API running in Vertex AI.
|
||
</summary>
|
||
<remarks>
|
||
See <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/overview">Model reference</a>.
|
||
See also https://cloud.google.com/nodejs/docs/reference/vertexai/latest/vertexai/vertexinit
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.#ctor(System.Net.Http.IHttpClientFactory,Mscc.GenerativeAI.Types.RequestOptions,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.VertexAI"/> class with access to Vertex AI Gemini API.
|
||
The default constructor attempts to read <c>.env</c> file and environment variables.
|
||
Sets default values, if available.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="requestOptions">Optional. Options for the request.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<remarks>The following environment variables are used:
|
||
<list type="table">
|
||
<item><term>GOOGLE_PROJECT_ID</term>
|
||
<description>Identifier of the Google Cloud project.</description></item>
|
||
<item><term>GOOGLE_REGION</term>
|
||
<description>Identifier of the Google Cloud region to use (default: "us-central1").</description></item>
|
||
</list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.#ctor(System.String,System.String,System.String,System.String,System.String,System.Net.Http.IHttpClientFactory,Mscc.GenerativeAI.Types.RequestOptions,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.VertexAI"/> class with access to Vertex AI Gemini API.
|
||
</summary>
|
||
<param name="projectId">Identifier of the Google Cloud project.</param>
|
||
<param name="region">Optional. Region to use (default: "us-central1").</param>
|
||
<param name="accessToken">Access token for the Google Cloud project.</param>
|
||
<param name="endpointId">Optional. Endpoint ID of the deployed model to use.</param>
|
||
<param name="apiVersion">Version of the API.</param>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="requestOptions">Optional. Options for the request.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="projectId"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.#ctor(System.String,System.String,System.Net.Http.IHttpClientFactory,Mscc.GenerativeAI.Types.RequestOptions,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.VertexAI"/> class with access to Vertex AI Gemini API.
|
||
</summary>
|
||
<param name="apiKey">API key for Vertex AI in express mode.</param>
|
||
<param name="apiVersion">Version of the API.</param>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="requestOptions">Optional. Options for the request.</param>
|
||
<param name="logger">Optional. Logger instance used for logging.</param>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="apiKey"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.GenerativeModel(System.String,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Mscc.GenerativeAI.Types.Tools,Mscc.GenerativeAI.Types.Content,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Create a generative model on Vertex 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>
|
||
<param name="logger">Optional. Logger instance used for logging.</param>
|
||
<returns>Generative model instance.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.GenerativeModel(Mscc.GenerativeAI.Types.CachedContent,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Create a generative model on Vertex 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>
|
||
<param name="logger">Optional. Logger instance used for logging.</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 "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.GenerativeModel(Mscc.GenerativeAI.Types.TuningJob,Mscc.GenerativeAI.Types.GenerationConfig,System.Collections.Generic.List{Mscc.GenerativeAI.Types.SafetySetting},Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Create a generative model on Vertex AI to use.
|
||
</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>
|
||
<returns>Generative model instance.</returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="tuningJob"/> is null.</exception>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.GetModel(System.String,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<inheritdoc cref="T:Mscc.GenerativeAI.IGenerativeAI"/>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.SupervisedTuningJob(System.String,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="model">Model to use.</param>
|
||
<param name="logger">Optional. Logger instance used for logging.</param>
|
||
<returns></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.ImageGenerationModel(System.String,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="model">Model to use (default: "imagegeneration")</param>
|
||
<param name="logger">Optional. Logger instance used for logging.</param>
|
||
<returns></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.ImageTextModel(System.String,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="model">Model to use (default: "imagetext")</param>
|
||
<param name="logger">Optional. Logger instance used for logging.</param>
|
||
<returns></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.RagEngineModel(Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
|
||
</summary>
|
||
<param name="logger">Optional. Logger instance used for logging.</param>
|
||
<returns></returns>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VertexAI.Guard">
|
||
<summary>
|
||
|
||
</summary>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "apiKey" is <see langword="null"/></exception>
|
||
<exception cref="T:System.ArgumentNullException">Thrown when "projectId" or "region" is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Mscc.GenerativeAI.VideoGenerationModel">
|
||
<summary>
|
||
Generates a video from the model given an input.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VideoGenerationModel.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.VideoGenerationModel"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VideoGenerationModel.#ctor(System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.VideoGenerationModel"/> class.
|
||
</summary>
|
||
<param name="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VideoGenerationModel.#ctor(System.String,System.String,System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.VideoGenerationModel"/> 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="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VideoGenerationModel.#ctor(System.String,System.String,System.String,System.Net.Http.IHttpClientFactory,Microsoft.Extensions.Logging.ILogger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Mscc.GenerativeAI.VideoGenerationModel"/> 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="httpClientFactory">Optional. The <see cref="T:System.Net.Http.IHttpClientFactory"/> to use for creating HttpClient instances.</param>
|
||
<param name="logger">Optional. Logger instance used for logging</param>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VideoGenerationModel.GenerateVideos(Mscc.GenerativeAI.Types.GenerateVideosRequest,Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates videos from the specified <see cref="T:Mscc.GenerativeAI.Types.GenerateVideosRequest"/>.
|
||
</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></returns>
|
||
<exception cref="T:System.ArgumentNullException"></exception>
|
||
</member>
|
||
<member name="M:Mscc.GenerativeAI.VideoGenerationModel.GenerateVideos(System.String,System.Int32,System.String,System.String,System.String,System.Nullable{Mscc.GenerativeAI.Types.PersonGeneration},System.Nullable{System.Boolean},Mscc.GenerativeAI.Types.RequestOptions,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Generates images from text prompt.
|
||
</summary>
|
||
<param name="prompt">Required. String to process.</param>
|
||
<param name="numberOfVideos">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="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="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.VideoGenerationModel.GenerateContent(System.String,Mscc.GenerativeAI.Types.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="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>
|
||
</members>
|
||
</doc>
|