{ "resources": { "batches": { "methods": { "list": { "id": "generativelanguage.batches.list", "path": "v1beta/{+name}", "flatPath": "v1beta/batches", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^batches$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "generativelanguage.batches.get", "path": "v1beta/{+name}", "flatPath": "v1beta/batches/{batchesId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^batches/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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." }, "delete": { "id": "generativelanguage.batches.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/batches/{batchesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^batches/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "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`." }, "cancel": { "id": "generativelanguage.batches.cancel", "path": "v1beta/{+name}:cancel", "flatPath": "v1beta/batches/{batchesId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^batches/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "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`." }, "updateGenerateContentBatch": { "id": "generativelanguage.batches.updateGenerateContentBatch", "path": "v1beta/{+name}:updateGenerateContentBatch", "flatPath": "v1beta/batches/{batchesId}:updateGenerateContentBatch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. Identifier. Resource name of the batch. Format: `batches/{batch_id}`.", "pattern": "^batches/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GenerateContentBatch" }, "response": { "$ref": "GenerateContentBatch" }, "description": "Updates a batch of GenerateContent requests for batch processing." }, "updateEmbedContentBatch": { "id": "generativelanguage.batches.updateEmbedContentBatch", "path": "v1beta/{+name}:updateEmbedContentBatch", "flatPath": "v1beta/batches/{batchesId}:updateEmbedContentBatch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. Identifier. Resource name of the batch. Format: `batches/{batch_id}`.", "pattern": "^batches/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "EmbedContentBatch" }, "response": { "$ref": "EmbedContentBatch" }, "description": "Updates a batch of EmbedContent requests for batch processing." } } }, "models": { "methods": { "generateContent": { "id": "generativelanguage.models.generateContent", "path": "v1beta/{+model}:generateContent", "flatPath": "v1beta/models/{modelsId}:generateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateContentRequest" }, "response": { "$ref": "GenerateContentResponse" }, "description": "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." }, "generateAnswer": { "id": "generativelanguage.models.generateAnswer", "path": "v1beta/{+model}:generateAnswer", "flatPath": "v1beta/models/{modelsId}:generateAnswer", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the grounded response. Format: `model=models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateAnswerRequest" }, "response": { "$ref": "GenerateAnswerResponse" }, "description": "Generates a grounded answer from the model given an input `GenerateAnswerRequest`." }, "streamGenerateContent": { "id": "generativelanguage.models.streamGenerateContent", "path": "v1beta/{+model}:streamGenerateContent", "flatPath": "v1beta/models/{modelsId}:streamGenerateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateContentRequest" }, "response": { "$ref": "GenerateContentResponse" }, "description": "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`." }, "embedContent": { "id": "generativelanguage.models.embedContent", "path": "v1beta/{+model}:embedContent", "flatPath": "v1beta/models/{modelsId}:embedContent", "httpMethod": "POST", "parameters": { "model": { "description": "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 `ListModels` method. Format: `models/{model}`", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "EmbedContentRequest" }, "response": { "$ref": "EmbedContentResponse" }, "description": "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)." }, "batchEmbedContents": { "id": "generativelanguage.models.batchEmbedContents", "path": "v1beta/{+model}:batchEmbedContents", "flatPath": "v1beta/models/{modelsId}:batchEmbedContents", "httpMethod": "POST", "parameters": { "model": { "description": "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 `ListModels` method. Format: `models/{model}`", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "BatchEmbedContentsRequest" }, "response": { "$ref": "BatchEmbedContentsResponse" }, "description": "Generates multiple embedding vectors from the input `Content` which consists of a batch of strings represented as `EmbedContentRequest` objects." }, "countTokens": { "id": "generativelanguage.models.countTokens", "path": "v1beta/{+model}:countTokens", "flatPath": "v1beta/models/{modelsId}:countTokens", "httpMethod": "POST", "parameters": { "model": { "description": "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 `ListModels` method. Format: `models/{model}`", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "CountTokensRequest" }, "response": { "$ref": "CountTokensResponse" }, "description": "Runs a model's tokenizer on input `Content` and returns the token count. Refer to the [tokens guide](https://ai.google.dev/gemini-api/docs/tokens) to learn more about tokens." }, "batchGenerateContent": { "id": "generativelanguage.models.batchGenerateContent", "path": "v1beta/{+model}:batchGenerateContent", "flatPath": "v1beta/models/{modelsId}:batchGenerateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "BatchGenerateContentRequest" }, "response": { "$ref": "Operation" }, "description": "Enqueues a batch of `GenerateContent` requests for batch processing." }, "asyncBatchEmbedContent": { "id": "generativelanguage.models.asyncBatchEmbedContent", "path": "v1beta/{+model}:asyncBatchEmbedContent", "flatPath": "v1beta/models/{modelsId}:asyncBatchEmbedContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "AsyncBatchEmbedContentRequest" }, "response": { "$ref": "Operation" }, "description": "Enqueues a batch of `EmbedContent` requests for batch processing. We have a `BatchEmbedContents` handler in `GenerativeService`, but it was synchronized. So we name this one to be `Async` to avoid confusion." }, "generateMessage": { "id": "generativelanguage.models.generateMessage", "path": "v1beta/{+model}:generateMessage", "flatPath": "v1beta/models/{modelsId}:generateMessage", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the model to use. Format: `name=models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateMessageRequest" }, "response": { "$ref": "GenerateMessageResponse" }, "description": "Generates a response from the model given an input `MessagePrompt`." }, "countMessageTokens": { "id": "generativelanguage.models.countMessageTokens", "path": "v1beta/{+model}:countMessageTokens", "flatPath": "v1beta/models/{modelsId}:countMessageTokens", "httpMethod": "POST", "parameters": { "model": { "description": "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 `ListModels` method. Format: `models/{model}`", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "CountMessageTokensRequest" }, "response": { "$ref": "CountMessageTokensResponse" }, "description": "Runs a model's tokenizer on a string and returns the token count." }, "get": { "id": "generativelanguage.models.get", "path": "v1beta/{+name}", "flatPath": "v1beta/models/{modelsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the model. This name should match a model name returned by the `ListModels` method. Format: `models/{model}`", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Model" }, "description": "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." }, "list": { "id": "generativelanguage.models.list", "path": "v1beta/models", "flatPath": "v1beta/models", "httpMethod": "GET", "parameters": { "pageSize": { "description": "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListModels` call. Provide the `page_token` returned by one request as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListModels` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [], "response": { "$ref": "ListModelsResponse" }, "description": "Lists the [`Model`s](https://ai.google.dev/gemini-api/docs/models/gemini) available through the Gemini API." }, "predict": { "id": "generativelanguage.models.predict", "path": "v1beta/{+model}:predict", "flatPath": "v1beta/models/{modelsId}:predict", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the model for prediction. Format: `name=models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "PredictRequest" }, "response": { "$ref": "PredictResponse" }, "description": "Performs a prediction request." }, "predictLongRunning": { "id": "generativelanguage.models.predictLongRunning", "path": "v1beta/{+model}:predictLongRunning", "flatPath": "v1beta/models/{modelsId}:predictLongRunning", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the model for prediction. Format: `name=models/{model}`.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "PredictLongRunningRequest" }, "response": { "$ref": "Operation" }, "description": "Same as Predict but returns an LRO." }, "generateText": { "id": "generativelanguage.models.generateText", "path": "v1beta/{+model}:generateText", "flatPath": "v1beta/models/{modelsId}:generateText", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` or `TunedModel` to use for generating the completion. Examples: models/text-bison-001 tunedModels/sentence-translator-u3b7m", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateTextRequest" }, "response": { "$ref": "GenerateTextResponse" }, "description": "Generates a response from the model given an input message." }, "embedText": { "id": "generativelanguage.models.embedText", "path": "v1beta/{+model}:embedText", "flatPath": "v1beta/models/{modelsId}:embedText", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The model name to use with the format model=models/{model}.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "EmbedTextRequest" }, "response": { "$ref": "EmbedTextResponse" }, "description": "Generates an embedding from the model given an input message." }, "batchEmbedText": { "id": "generativelanguage.models.batchEmbedText", "path": "v1beta/{+model}:batchEmbedText", "flatPath": "v1beta/models/{modelsId}:batchEmbedText", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the embedding. Examples: models/embedding-gecko-001", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "BatchEmbedTextRequest" }, "response": { "$ref": "BatchEmbedTextResponse" }, "description": "Generates multiple embeddings from the model given input text in a synchronous call." }, "countTextTokens": { "id": "generativelanguage.models.countTextTokens", "path": "v1beta/{+model}:countTextTokens", "flatPath": "v1beta/models/{modelsId}:countTextTokens", "httpMethod": "POST", "parameters": { "model": { "description": "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 `ListModels` method. Format: `models/{model}`", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "CountTextTokensRequest" }, "response": { "$ref": "CountTextTokensResponse" }, "description": "Runs a model's tokenizer on a text and returns the token count." } }, "resources": { "operations": { "methods": { "list": { "id": "generativelanguage.models.operations.list", "path": "v1beta/{+name}/operations", "flatPath": "v1beta/models/{modelsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^models/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "generativelanguage.models.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^models/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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." } } } } }, "tunedModels": { "methods": { "generateContent": { "id": "generativelanguage.tunedModels.generateContent", "path": "v1beta/{+model}:generateContent", "flatPath": "v1beta/tunedModels/{tunedModelsId}:generateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateContentRequest" }, "response": { "$ref": "GenerateContentResponse" }, "description": "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." }, "streamGenerateContent": { "id": "generativelanguage.tunedModels.streamGenerateContent", "path": "v1beta/{+model}:streamGenerateContent", "flatPath": "v1beta/tunedModels/{tunedModelsId}:streamGenerateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateContentRequest" }, "response": { "$ref": "GenerateContentResponse" }, "description": "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`." }, "batchGenerateContent": { "id": "generativelanguage.tunedModels.batchGenerateContent", "path": "v1beta/{+model}:batchGenerateContent", "flatPath": "v1beta/tunedModels/{tunedModelsId}:batchGenerateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "BatchGenerateContentRequest" }, "response": { "$ref": "Operation" }, "description": "Enqueues a batch of `GenerateContent` requests for batch processing." }, "asyncBatchEmbedContent": { "id": "generativelanguage.tunedModels.asyncBatchEmbedContent", "path": "v1beta/{+model}:asyncBatchEmbedContent", "flatPath": "v1beta/tunedModels/{tunedModelsId}:asyncBatchEmbedContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "AsyncBatchEmbedContentRequest" }, "response": { "$ref": "Operation" }, "description": "Enqueues a batch of `EmbedContent` requests for batch processing. We have a `BatchEmbedContents` handler in `GenerativeService`, but it was synchronized. So we name this one to be `Async` to avoid confusion." }, "get": { "id": "generativelanguage.tunedModels.get", "path": "v1beta/{+name}", "flatPath": "v1beta/tunedModels/{tunedModelsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the model. Format: `tunedModels/my-model-id`", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "TunedModel" }, "description": "Gets information about a specific TunedModel." }, "list": { "id": "generativelanguage.tunedModels.list", "path": "v1beta/tunedModels", "flatPath": "v1beta/tunedModels", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. The maximum number of `TunedModels` to return (per page). The service may return fewer tuned models. If unspecified, at most 10 tuned models will be returned. This method returns at most 1000 models per page, even if you pass a larger page_size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListTunedModels` call. Provide the `page_token` returned by one request as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListTunedModels` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "description": "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 Examples: \"owner:me\" returns all tuned models to which caller has owner role \"readers:me\" returns all tuned models to which caller has reader role \"readers:everyone\" returns all tuned models that are shared with everyone", "location": "query", "type": "string" } }, "parameterOrder": [], "response": { "$ref": "ListTunedModelsResponse" }, "description": "Lists created tuned models." }, "create": { "id": "generativelanguage.tunedModels.create", "path": "v1beta/tunedModels", "flatPath": "v1beta/tunedModels", "httpMethod": "POST", "parameters": { "tunedModelId": { "description": "Optional. The unique id for the tuned model if specified. This value should be up to 40 characters, the first character must be a letter, the last could be a letter or a number. The id must match the regular expression: `[a-z]([a-z0-9-]{0,38}[a-z0-9])?`.", "location": "query", "type": "string" } }, "parameterOrder": [], "request": { "$ref": "TunedModel" }, "response": { "$ref": "Operation" }, "description": "Creates a tuned model. Check intermediate tuning progress (if any) through the [google.longrunning.Operations] service. Access status and results through the Operations service. Example: GET /v1/tunedModels/az2mb0bpw6i/operations/000-111-222" }, "patch": { "id": "generativelanguage.tunedModels.patch", "path": "v1beta/{+name}", "flatPath": "v1beta/tunedModels/{tunedModelsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. The tuned model name. A unique name will be generated on create. Example: `tunedModels/az2mb0bpw6i` 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 = `Sentence Translator` * name = `tunedModels/sentence-translator-u3b7m`", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "TunedModel" }, "response": { "$ref": "TunedModel" }, "description": "Updates a tuned model." }, "delete": { "id": "generativelanguage.tunedModels.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/tunedModels/{tunedModelsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the model. Format: `tunedModels/my-model-id`", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes a tuned model." }, "transferOwnership": { "id": "generativelanguage.tunedModels.transferOwnership", "path": "v1beta/{+name}:transferOwnership", "flatPath": "v1beta/tunedModels/{tunedModelsId}:transferOwnership", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The resource name of the tuned model to transfer ownership. Format: `tunedModels/my-model-id`", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "TransferOwnershipRequest" }, "response": { "$ref": "TransferOwnershipResponse" }, "description": "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." }, "generateText": { "id": "generativelanguage.tunedModels.generateText", "path": "v1beta/{+model}:generateText", "flatPath": "v1beta/tunedModels/{tunedModelsId}:generateText", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` or `TunedModel` to use for generating the completion. Examples: models/text-bison-001 tunedModels/sentence-translator-u3b7m", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateTextRequest" }, "response": { "$ref": "GenerateTextResponse" }, "description": "Generates a response from the model given an input message." } }, "resources": { "operations": { "methods": { "list": { "id": "generativelanguage.tunedModels.operations.list", "path": "v1beta/{+name}/operations", "flatPath": "v1beta/tunedModels/{tunedModelsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "generativelanguage.tunedModels.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/tunedModels/{tunedModelsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^tunedModels/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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." } } }, "permissions": { "methods": { "create": { "id": "generativelanguage.tunedModels.permissions.create", "path": "v1beta/{+parent}/permissions", "flatPath": "v1beta/tunedModels/{tunedModelsId}/permissions", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the `Permission`. Formats: `tunedModels/{tuned_model}` `corpora/{corpus}`", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "description": "Create a permission to a specific resource." }, "get": { "id": "generativelanguage.tunedModels.permissions.get", "path": "v1beta/{+name}", "flatPath": "v1beta/tunedModels/{tunedModelsId}/permissions/{permissionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the permission. Formats: `tunedModels/{tuned_model}/permissions/{permission}` `corpora/{corpus}/permissions/{permission}`", "pattern": "^tunedModels/[^/]+/permissions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Permission" }, "description": "Gets information about a specific Permission." }, "list": { "id": "generativelanguage.tunedModels.permissions.list", "path": "v1beta/{+parent}/permissions", "flatPath": "v1beta/tunedModels/{tunedModelsId}/permissions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource of the permissions. Formats: `tunedModels/{tuned_model}` `corpora/{corpus}`", "pattern": "^tunedModels/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of `Permission`s to return (per page). The service may return fewer permissions. If unspecified, at most 10 permissions will be returned. This method returns at most 1000 permissions per page, even if you pass larger page_size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListPermissions` call. Provide the `page_token` returned by one request as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListPermissions` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListPermissionsResponse" }, "description": "Lists permissions for the specific resource." }, "patch": { "id": "generativelanguage.tunedModels.permissions.patch", "path": "v1beta/{+name}", "flatPath": "v1beta/tunedModels/{tunedModelsId}/permissions/{permissionsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "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.", "pattern": "^tunedModels/[^/]+/permissions/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The list of fields to update. Accepted ones: - role (`Permission.role` field)", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "description": "Updates the permission." }, "delete": { "id": "generativelanguage.tunedModels.permissions.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/tunedModels/{tunedModelsId}/permissions/{permissionsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the permission. Formats: `tunedModels/{tuned_model}/permissions/{permission}` `corpora/{corpus}/permissions/{permission}`", "pattern": "^tunedModels/[^/]+/permissions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes the permission." } } } } }, "dynamic": { "methods": { "generateContent": { "id": "generativelanguage.dynamic.generateContent", "path": "v1beta/{+model}:generateContent", "flatPath": "v1beta/dynamic/{dynamicId}:generateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^dynamic/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateContentRequest" }, "response": { "$ref": "GenerateContentResponse" }, "description": "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." }, "streamGenerateContent": { "id": "generativelanguage.dynamic.streamGenerateContent", "path": "v1beta/{+model}:streamGenerateContent", "flatPath": "v1beta/dynamic/{dynamicId}:streamGenerateContent", "httpMethod": "POST", "parameters": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "pattern": "^dynamic/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "model" ], "request": { "$ref": "GenerateContentRequest" }, "response": { "$ref": "GenerateContentResponse" }, "description": "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`." } } }, "cachedContents": { "methods": { "list": { "id": "generativelanguage.cachedContents.list", "path": "v1beta/cachedContents", "flatPath": "v1beta/cachedContents", "httpMethod": "GET", "parameters": { "pageSize": { "description": "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "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.", "location": "query", "type": "string" } }, "parameterOrder": [], "response": { "$ref": "ListCachedContentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Lists CachedContents." }, "create": { "id": "generativelanguage.cachedContents.create", "path": "v1beta/cachedContents", "flatPath": "v1beta/cachedContents", "httpMethod": "POST", "parameters": {}, "parameterOrder": [], "request": { "$ref": "CachedContent" }, "response": { "$ref": "CachedContent" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Creates CachedContent resource." }, "get": { "id": "generativelanguage.cachedContents.get", "path": "v1beta/{+name}", "flatPath": "v1beta/cachedContents/{cachedContentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name referring to the content cache entry. Format: `cachedContents/{id}`", "pattern": "^cachedContents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "CachedContent" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Reads CachedContent resource." }, "patch": { "id": "generativelanguage.cachedContents.patch", "path": "v1beta/{+name}", "flatPath": "v1beta/cachedContents/{cachedContentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. Identifier. The resource name referring to the cached content. Format: `cachedContents/{id}`", "pattern": "^cachedContents/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CachedContent" }, "response": { "$ref": "CachedContent" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Updates CachedContent resource (only expiration is updatable)." }, "delete": { "id": "generativelanguage.cachedContents.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/cachedContents/{cachedContentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name referring to the content cache entry Format: `cachedContents/{id}`", "pattern": "^cachedContents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Deletes CachedContent resource." } } }, "media": { "methods": { "upload": { "id": "generativelanguage.media.upload", "path": "v1beta/files", "flatPath": "v1beta/files", "httpMethod": "POST", "parameters": {}, "parameterOrder": [], "supportsMediaUpload": true, "mediaUpload": { "accept": [ "*/*" ], "maxSize": "2147483648", "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/v1beta/files" }, "simple": { "multipart": true, "path": "/upload/v1beta/files" } } }, "request": { "$ref": "CreateFileRequest" }, "response": { "$ref": "CreateFileResponse" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Creates a `File`." }, "uploadToFileSearchStore": { "id": "generativelanguage.media.uploadToFileSearchStore", "path": "v1beta/{+fileSearchStoreName}:uploadToFileSearchStore", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}:uploadToFileSearchStore", "httpMethod": "POST", "parameters": { "fileSearchStoreName": { "description": "Required. Immutable. The name of the `FileSearchStore` to upload the file into. Example: `fileSearchStores/my-file-search-store-123`", "pattern": "^fileSearchStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "fileSearchStoreName" ], "supportsMediaUpload": true, "mediaUpload": { "accept": [ "*/*" ], "maxSize": "104857600", "protocols": { "resumable": { "multipart": true, "path": "/resumable/upload/v1beta/{+fileSearchStoreName}:uploadToFileSearchStore" }, "simple": { "multipart": true, "path": "/upload/v1beta/{+fileSearchStoreName}:uploadToFileSearchStore" } } }, "request": { "$ref": "UploadToFileSearchStoreRequest" }, "response": { "$ref": "CustomLongRunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Uploads data to a FileSearchStore, preprocesses and chunks before storing it in a FileSearchStore Document." } } }, "files": { "methods": { "register": { "id": "generativelanguage.files.register", "path": "v1beta/files:register", "flatPath": "v1beta/files:register", "httpMethod": "POST", "parameters": {}, "parameterOrder": [], "request": { "$ref": "RegisterFilesRequest" }, "response": { "$ref": "RegisterFilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "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." }, "list": { "id": "generativelanguage.files.list", "path": "v1beta/files", "flatPath": "v1beta/files", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. Maximum number of `File`s to return per page. If unspecified, defaults to 10. Maximum `page_size` is 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token from a previous `ListFiles` call.", "location": "query", "type": "string" } }, "parameterOrder": [], "response": { "$ref": "ListFilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Lists the metadata for `File`s owned by the requesting project." }, "get": { "id": "generativelanguage.files.get", "path": "v1beta/{+name}", "flatPath": "v1beta/files/{filesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the `File` to get. Example: `files/abc-123`", "pattern": "^files/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "File" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Gets the metadata for the given `File`." }, "delete": { "id": "generativelanguage.files.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/files/{filesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the `File` to delete. Example: `files/abc-123`", "pattern": "^files/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Deletes the `File`." } } }, "generatedFiles": { "methods": { "list": { "id": "generativelanguage.generatedFiles.list", "path": "v1beta/generatedFiles", "flatPath": "v1beta/generatedFiles", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. Maximum number of `GeneratedFile`s to return per page. If unspecified, defaults to 10. Maximum `page_size` is 50.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token from a previous `ListGeneratedFiles` call.", "location": "query", "type": "string" } }, "parameterOrder": [], "response": { "$ref": "ListGeneratedFilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Lists the generated files owned by the requesting project." } }, "resources": { "operations": { "methods": { "get": { "id": "generativelanguage.generatedFiles.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/generatedFiles/{generatedFilesId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^generatedFiles/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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." } } } } }, "fileSearchStores": { "methods": { "create": { "id": "generativelanguage.fileSearchStores.create", "path": "v1beta/fileSearchStores", "flatPath": "v1beta/fileSearchStores", "httpMethod": "POST", "parameters": {}, "parameterOrder": [], "request": { "$ref": "FileSearchStore" }, "response": { "$ref": "FileSearchStore" }, "description": "Creates an empty `FileSearchStore`." }, "get": { "id": "generativelanguage.fileSearchStores.get", "path": "v1beta/{+name}", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the `FileSearchStore`. Example: `fileSearchStores/my-file-search-store-123`", "pattern": "^fileSearchStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "FileSearchStore" }, "description": "Gets information about a specific `FileSearchStore`." }, "delete": { "id": "generativelanguage.fileSearchStores.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the `FileSearchStore`. Example: `fileSearchStores/my-file-search-store-123`", "pattern": "^fileSearchStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "force": { "description": "Optional. If set to true, any `Document`s and objects related to this `FileSearchStore` will also be deleted. If false (the default), a `FAILED_PRECONDITION` error will be returned if `FileSearchStore` contains any `Document`s.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes a `FileSearchStore`." }, "list": { "id": "generativelanguage.fileSearchStores.list", "path": "v1beta/fileSearchStores", "flatPath": "v1beta/fileSearchStores", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. The maximum number of `FileSearchStores` to return (per page). The service may return fewer `FileSearchStores`. If unspecified, at most 10 `FileSearchStores` will be returned. The maximum size limit is 20 `FileSearchStores` per page.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListFileSearchStores` call. Provide the `next_page_token` returned in the response as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListFileSearchStores` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [], "response": { "$ref": "ListFileSearchStoresResponse" }, "description": "Lists all `FileSearchStores` owned by the user." }, "importFile": { "id": "generativelanguage.fileSearchStores.importFile", "path": "v1beta/{+fileSearchStoreName}:importFile", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}:importFile", "httpMethod": "POST", "parameters": { "fileSearchStoreName": { "description": "Required. Immutable. The name of the `FileSearchStore` to import the file into. Example: `fileSearchStores/my-file-search-store-123`", "pattern": "^fileSearchStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "fileSearchStoreName" ], "request": { "$ref": "ImportFileRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/devstorage.read_only" ], "description": "Imports a `File` from File Service to a `FileSearchStore`." } }, "resources": { "operations": { "methods": { "get": { "id": "generativelanguage.fileSearchStores.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^fileSearchStores/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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." } } }, "upload": { "resources": { "operations": { "methods": { "get": { "id": "generativelanguage.fileSearchStores.upload.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}/upload/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^fileSearchStores/[^/]+/upload/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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." } } } } }, "documents": { "methods": { "get": { "id": "generativelanguage.fileSearchStores.documents.get", "path": "v1beta/{+name}", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}/documents/{documentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the `Document` to retrieve. Example: `fileSearchStores/my-file-search-store-123/documents/the-doc-abc`", "pattern": "^fileSearchStores/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Document" }, "description": "Gets information about a specific `Document`." }, "delete": { "id": "generativelanguage.fileSearchStores.documents.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}/documents/{documentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the `Document` to delete. Example: `fileSearchStores/my-file-search-store-123/documents/the-doc-abc`", "pattern": "^fileSearchStores/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "force": { "description": "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.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes a `Document`." }, "list": { "id": "generativelanguage.fileSearchStores.documents.list", "path": "v1beta/{+parent}/documents", "flatPath": "v1beta/fileSearchStores/{fileSearchStoresId}/documents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The name of the `FileSearchStore` containing `Document`s. Example: `fileSearchStores/my-file-search-store-123`", "pattern": "^fileSearchStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of `Document`s to return (per page). The service may return fewer `Document`s. If unspecified, at most 10 `Document`s will be returned. The maximum size limit is 20 `Document`s per page.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListDocuments` call. Provide the `next_page_token` returned in the response as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListDocuments` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDocumentsResponse" }, "description": "Lists all `Document`s in a `Corpus`." } } } } }, "corpora": { "methods": { "create": { "id": "generativelanguage.corpora.create", "path": "v1beta/corpora", "flatPath": "v1beta/corpora", "httpMethod": "POST", "parameters": {}, "parameterOrder": [], "request": { "$ref": "Corpus" }, "response": { "$ref": "Corpus" }, "description": "Creates an empty `Corpus`." }, "get": { "id": "generativelanguage.corpora.get", "path": "v1beta/{+name}", "flatPath": "v1beta/corpora/{corporaId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the `Corpus`. Example: `corpora/my-corpus-123`", "pattern": "^corpora/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Corpus" }, "description": "Gets information about a specific `Corpus`." }, "delete": { "id": "generativelanguage.corpora.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/corpora/{corporaId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the `Corpus`. Example: `corpora/my-corpus-123`", "pattern": "^corpora/[^/]+$", "location": "path", "required": true, "type": "string" }, "force": { "description": "Optional. If set to true, any `Document`s and objects related to this `Corpus` will also be deleted. If false (the default), a `FAILED_PRECONDITION` error will be returned if `Corpus` contains any `Document`s.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes a `Corpus`." }, "list": { "id": "generativelanguage.corpora.list", "path": "v1beta/corpora", "flatPath": "v1beta/corpora", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. The maximum number of `Corpora` to return (per page). The service may return fewer `Corpora`. If unspecified, at most 10 `Corpora` will be returned. The maximum size limit is 20 `Corpora` per page.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListCorpora` call. Provide the `next_page_token` returned in the response as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListCorpora` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [], "response": { "$ref": "ListCorporaResponse" }, "description": "Lists all `Corpora` owned by the user." } }, "resources": { "operations": { "methods": { "get": { "id": "generativelanguage.corpora.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/corpora/{corporaId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^corpora/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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." } } }, "permissions": { "methods": { "create": { "id": "generativelanguage.corpora.permissions.create", "path": "v1beta/{+parent}/permissions", "flatPath": "v1beta/corpora/{corporaId}/permissions", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the `Permission`. Formats: `tunedModels/{tuned_model}` `corpora/{corpus}`", "pattern": "^corpora/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "description": "Create a permission to a specific resource." }, "get": { "id": "generativelanguage.corpora.permissions.get", "path": "v1beta/{+name}", "flatPath": "v1beta/corpora/{corporaId}/permissions/{permissionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the permission. Formats: `tunedModels/{tuned_model}/permissions/{permission}` `corpora/{corpus}/permissions/{permission}`", "pattern": "^corpora/[^/]+/permissions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Permission" }, "description": "Gets information about a specific Permission." }, "list": { "id": "generativelanguage.corpora.permissions.list", "path": "v1beta/{+parent}/permissions", "flatPath": "v1beta/corpora/{corporaId}/permissions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource of the permissions. Formats: `tunedModels/{tuned_model}` `corpora/{corpus}`", "pattern": "^corpora/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of `Permission`s to return (per page). The service may return fewer permissions. If unspecified, at most 10 permissions will be returned. This method returns at most 1000 permissions per page, even if you pass larger page_size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListPermissions` call. Provide the `page_token` returned by one request as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListPermissions` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListPermissionsResponse" }, "description": "Lists permissions for the specific resource." }, "patch": { "id": "generativelanguage.corpora.permissions.patch", "path": "v1beta/{+name}", "flatPath": "v1beta/corpora/{corporaId}/permissions/{permissionsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "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.", "pattern": "^corpora/[^/]+/permissions/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The list of fields to update. Accepted ones: - role (`Permission.role` field)", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Permission" }, "response": { "$ref": "Permission" }, "description": "Updates the permission." }, "delete": { "id": "generativelanguage.corpora.permissions.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/corpora/{corporaId}/permissions/{permissionsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the permission. Formats: `tunedModels/{tuned_model}/permissions/{permission}` `corpora/{corpus}/permissions/{permission}`", "pattern": "^corpora/[^/]+/permissions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes the permission." } } } } } }, "id": "generativelanguage:v1beta", "ownerDomain": "google.com", "protocol": "rest", "documentationLink": "https://developers.generativeai.google/api", "title": "Gemini API", "fullyEncodeReservedExpansion": true, "schemas": { "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "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}`.", "type": "string" }, "metadata": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "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.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "The normal, successful response of the operation. 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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "Status": { "id": "Status", "description": "The `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 `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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "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.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Empty": { "id": "Empty", "description": "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); }", "type": "object", "properties": {} }, "GenerateContentRequest": { "id": "GenerateContentRequest", "description": "Request to generate a completion from the model.", "type": "object", "properties": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "type": "string" }, "systemInstruction": { "description": "Optional. Developer set [system instruction(s)](https://ai.google.dev/gemini-api/docs/system-instructions). Currently, text only.", "$ref": "Content" }, "contents": { "description": "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.", "type": "array", "items": { "$ref": "Content" } }, "tools": { "description": "Optional. A list of `Tools` the `Model` may use to generate the next response. 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`. Supported `Tool`s are `Function` and `code_execution`. 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.", "type": "array", "items": { "$ref": "Tool" } }, "toolConfig": { "description": "Optional. Tool configuration for any `Tool` 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.", "$ref": "ToolConfig" }, "safetySettings": { "description": "Optional. A list of unique `SafetySetting` instances for blocking unsafe content. This will be enforced on the `GenerateContentRequest.contents` and `GenerateContentResponse.candidates`. There should not be more than one setting for each `SafetyCategory` 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 `SafetyCategory` specified in the safety_settings. If there is no `SafetySetting` for a given `SafetyCategory` 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.", "type": "array", "items": { "$ref": "SafetySetting" } }, "generationConfig": { "description": "Optional. Configuration options for model generation and outputs.", "$ref": "GenerationConfig" }, "cachedContent": { "description": "Optional. The name of the content [cached](https://ai.google.dev/gemini-api/docs/caching) to use as context to serve the prediction. Format: `cachedContents/{cachedContent}`", "type": "string" }, "serviceTier": { "description": "Optional. The service tier of the request.", "type": "string", "enumDescriptions": [ "Default service tier, which is standard.", "Standard service tier.", "Flex service tier.", "Priority service tier." ], "enum": [ "unspecified", "standard", "flex", "priority" ] }, "store": { "description": "Optional. Configures the logging behavior for a given request. If set, it takes precedence over the project-level logging config.", "type": "boolean" } } }, "Content": { "id": "Content", "description": "The base structured datatype containing multi-part content of a message. 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.", "type": "object", "properties": { "parts": { "description": "Ordered `Parts` that constitute a single message. Parts may have different MIME types.", "type": "array", "items": { "$ref": "Part" } }, "role": { "description": "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.", "type": "string" } } }, "Part": { "id": "Part", "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.", "type": "object", "properties": { "text": { "description": "Inline text.", "type": "string" }, "inlineData": { "description": "Inline media bytes.", "$ref": "Blob" }, "functionCall": { "description": "A predicted `FunctionCall` returned from the model that contains a string representing the `FunctionDeclaration.name` with the arguments and their values.", "$ref": "FunctionCall" }, "functionResponse": { "description": "The result output of 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.", "$ref": "FunctionResponse" }, "fileData": { "description": "URI based data.", "$ref": "FileData" }, "executableCode": { "description": "Code generated by the model that is meant to be executed.", "$ref": "ExecutableCode" }, "codeExecutionResult": { "description": "Result of executing the `ExecutableCode`.", "$ref": "CodeExecutionResult" }, "toolCall": { "description": "Server-side tool call. This field is populated when the model predicts a tool invocation that should be executed on the server. The client is expected to echo this message back to the API.", "$ref": "ToolCall" }, "toolResponse": { "description": "The output from a server-side `ToolCall` execution. This field is populated by the client with the results of executing the corresponding `ToolCall`.", "$ref": "ToolResponse" }, "videoMetadata": { "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.", "$ref": "VideoMetadata" }, "thought": { "description": "Optional. Indicates if the part is thought from the model.", "type": "boolean" }, "thoughtSignature": { "description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests.", "type": "string", "format": "byte" }, "partMetadata": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "mediaResolution": { "description": "Optional. Media resolution for the input media.", "$ref": "MediaResolution" } } }, "Blob": { "id": "Blob", "description": "Raw media bytes. Text should not be sent as raw bytes, use the 'text' field.", "type": "object", "properties": { "mimeType": { "description": "The IANA standard MIME type of the source data. Examples of supported types: - Images: image/png, image/jpeg, image/jpg, image/webp, image/heic, image/heif, image/gif, image/avif - Audio: audio/*, video/audio/s16le, video/audio/wav - Video: video/* - Text: text/plain, text/html, text/css, text/javascript, text/x-typescript, text/csv, text/markdown, text/x-python, text/xml, text/rtf, video/text/timestamp - Applications: application/x-javascript, application/x-typescript, application/x-python-code, application/json, application/x-ipynb+json, application/rtf, application/pdf For additional context, see [Supported file formats](https://ai.google.dev/gemini-api/docs/file-input-methods#supported-content-types). //", "type": "string" }, "data": { "description": "Raw bytes for media formats.", "type": "string", "format": "byte" } } }, "FunctionCall": { "id": "FunctionCall", "description": "A predicted `FunctionCall` returned from the model that contains a string representing the `FunctionDeclaration.name` with the arguments and their values.", "type": "object", "properties": { "id": { "description": "Optional. Unique identifier of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.", "type": "string" }, "name": { "description": "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 128.", "type": "string" }, "args": { "description": "Optional. The function parameters and values in JSON object format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "FunctionResponse": { "id": "FunctionResponse", "description": "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.", "type": "object", "properties": { "id": { "description": "Optional. The identifier of the function call this response is for. Populated by the client to match the corresponding function call `id`.", "type": "string" }, "name": { "description": "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 128.", "type": "string" }, "response": { "description": "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. Multimedia can be included by using a subobject containing a single \"$ref\" key whose value is the `inline_data.display_name` of a `FunctionResponsePart` holding the multimedia. See https://ai.google.dev/gemini-api/docs/function-calling#multimodal.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parts": { "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.", "type": "array", "items": { "$ref": "FunctionResponsePart" } }, "willContinue": { "description": "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 `response` with `will_continue=False` 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 `scheduling` to `SILENT`.", "type": "boolean" }, "scheduling": { "description": "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.", "type": "string", "enumDescriptions": [ "This value is unused.", "Only add the result to the conversation context, do not interrupt or trigger generation.", "Add the result to the conversation context, and prompt to generate output without interrupting ongoing generation.", "Add the result to the conversation context, interrupt ongoing generation and prompt to generate output." ], "enum": [ "SCHEDULING_UNSPECIFIED", "SILENT", "WHEN_IDLE", "INTERRUPT" ] } } }, "FunctionResponsePart": { "id": "FunctionResponsePart", "description": "A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.", "type": "object", "properties": { "inlineData": { "description": "Inline media bytes.", "$ref": "FunctionResponseBlob" } } }, "FunctionResponseBlob": { "id": "FunctionResponseBlob", "description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'FunctionResponse.response' field.", "type": "object", "properties": { "mimeType": { "description": "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).", "type": "string" }, "data": { "description": "Raw bytes for media formats.", "type": "string", "format": "byte" } } }, "FileData": { "id": "FileData", "description": "URI based data.", "type": "object", "properties": { "mimeType": { "description": "Optional. The IANA standard MIME type of the source data.", "type": "string" }, "fileUri": { "description": "Required. URI.", "type": "string" } } }, "ExecutableCode": { "id": "ExecutableCode", "description": "Code generated by the model that is meant to be executed, and the result returned to the model. Only generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding `CodeExecutionResult` will also be generated.", "type": "object", "properties": { "id": { "description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.", "type": "string" }, "language": { "description": "Required. Programming language of the `code`.", "type": "string", "enumDescriptions": [ "Unspecified language. This value should not be used.", "Python \u003e= 3.10, with numpy and simpy available. Python is the default language." ], "enum": [ "LANGUAGE_UNSPECIFIED", "PYTHON" ] }, "code": { "description": "Required. The code to be executed.", "type": "string" } } }, "CodeExecutionResult": { "id": "CodeExecutionResult", "description": "Result of executing the `ExecutableCode`. Generated only when the `CodeExecution` tool is used.", "type": "object", "properties": { "id": { "description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.", "type": "string" }, "outcome": { "description": "Required. Outcome of the code execution.", "type": "string", "enumDescriptions": [ "Unspecified status. This value should not be used.", "Code execution completed successfully. `output` contains the stdout, if any.", "Code execution failed. `output` contains the stderr and stdout, if any.", "Code execution ran for too long, and was cancelled. There may or may not be a partial `output` present." ], "enum": [ "OUTCOME_UNSPECIFIED", "OUTCOME_OK", "OUTCOME_FAILED", "OUTCOME_DEADLINE_EXCEEDED" ] }, "output": { "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", "type": "string" } } }, "ToolCall": { "id": "ToolCall", "description": "A predicted server-side `ToolCall` returned from the model. This message contains information about a tool that the model wants to invoke. The client is NOT expected to execute this `ToolCall`. Instead, the client should pass this `ToolCall` back to the API in a subsequent turn within a `Content` message, along with the corresponding `ToolResponse`.", "type": "object", "properties": { "id": { "description": "Optional. Unique identifier of the tool call. The server returns the tool response with the matching `id`.", "type": "string" }, "toolType": { "description": "Required. The type of tool that was called.", "type": "string", "enumDescriptions": [ "Unspecified tool type.", "Google search tool, maps to Tool.google_search.search_types.web_search.", "Image search tool, maps to Tool.google_search.search_types.image_search.", "URL context tool, maps to Tool.url_context.", "Google maps tool, maps to Tool.google_maps.", "File search tool, maps to Tool.file_search." ], "enum": [ "TOOL_TYPE_UNSPECIFIED", "GOOGLE_SEARCH_WEB", "GOOGLE_SEARCH_IMAGE", "URL_CONTEXT", "GOOGLE_MAPS", "FILE_SEARCH" ] }, "args": { "description": "Optional. The tool call arguments. Example: {\"arg1\" : \"value1\", \"arg2\" : \"value2\" , ...}", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "ToolResponse": { "id": "ToolResponse", "description": "The output from a server-side `ToolCall` execution. This message contains the results of a tool invocation that was initiated by a `ToolCall` from the model. The client should pass this `ToolResponse` back to the API in a subsequent turn within a `Content` message, along with the corresponding `ToolCall`.", "type": "object", "properties": { "id": { "description": "Optional. The identifier of the tool call this response is for.", "type": "string" }, "toolType": { "description": "Required. The type of tool that was called, matching the `tool_type` in the corresponding `ToolCall`.", "type": "string", "enumDescriptions": [ "Unspecified tool type.", "Google search tool, maps to Tool.google_search.search_types.web_search.", "Image search tool, maps to Tool.google_search.search_types.image_search.", "URL context tool, maps to Tool.url_context.", "Google maps tool, maps to Tool.google_maps.", "File search tool, maps to Tool.file_search." ], "enum": [ "TOOL_TYPE_UNSPECIFIED", "GOOGLE_SEARCH_WEB", "GOOGLE_SEARCH_IMAGE", "URL_CONTEXT", "GOOGLE_MAPS", "FILE_SEARCH" ] }, "response": { "description": "Optional. The tool response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "VideoMetadata": { "id": "VideoMetadata", "deprecated": true, "description": "Deprecated: Use `GenerateContentRequest.processing_options` instead. Metadata describes the input video content.", "type": "object", "properties": { "startOffset": { "description": "Optional. The start offset of the video.", "type": "string", "format": "google-duration" }, "endOffset": { "description": "Optional. The end offset of the video.", "type": "string", "format": "google-duration" }, "fps": { "description": "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].", "type": "number", "format": "double" } } }, "Tool": { "id": "Tool", "description": "Tool details that the model may use to generate response. 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. Next ID: 16", "type": "object", "properties": { "functionDeclarations": { "description": "Optional. A list of `FunctionDeclarations` 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.", "type": "array", "items": { "$ref": "FunctionDeclaration" } }, "googleSearchRetrieval": { "description": "Optional. Retrieval tool that is powered by Google search.", "$ref": "GoogleSearchRetrieval" }, "codeExecution": { "description": "Optional. Enables the model to execute code as part of generation.", "$ref": "CodeExecution" }, "googleSearch": { "description": "Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "$ref": "GoogleSearch" }, "computerUse": { "description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.", "$ref": "ComputerUse" }, "urlContext": { "description": "Optional. Tool to support URL context retrieval.", "$ref": "UrlContext" }, "fileSearch": { "description": "Optional. FileSearch tool type. Tool to retrieve knowledge from Semantic Retrieval corpora.", "$ref": "FileSearch" }, "mcpServers": { "description": "Optional. MCP Servers to connect to.", "type": "array", "items": { "$ref": "McpServer" } }, "googleMaps": { "description": "Optional. Tool that allows grounding the model's response with geospatial context related to the user's query.", "$ref": "GoogleMaps" } } }, "FunctionDeclaration": { "id": "FunctionDeclaration", "description": "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 `Tool` by the model and executed by the client.", "type": "object", "properties": { "name": { "description": "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 128.", "type": "string" }, "description": { "description": "Required. A brief description of the function.", "type": "string" }, "parameters": { "description": "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.", "$ref": "Schema" }, "parametersJsonSchema": { "description": "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: ``` { \"type\": \"object\", \"properties\": { \"name\": { \"type\": \"string\" }, \"age\": { \"type\": \"integer\" } }, \"additionalProperties\": false, \"required\": [\"name\", \"age\"], \"propertyOrdering\": [\"name\", \"age\"] } ``` This field is mutually exclusive with `parameters`.", "type": "any" }, "response": { "description": "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.", "$ref": "Schema" }, "responseJsonSchema": { "description": "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 `response`.", "type": "any" }, "behavior": { "description": "Optional. Specifies the function Behavior. Currently only supported by the BidiGenerateContent method.", "type": "string", "enumDescriptions": [ "This value is unused.", "If set, the system will wait to receive the function response before continuing the conversation.", "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." ], "enum": [ "UNSPECIFIED", "BLOCKING", "NON_BLOCKING" ] } } }, "Schema": { "id": "Schema", "description": "The `Schema` 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).", "type": "object", "properties": { "type": { "description": "Required. Data type.", "type": "string", "enumDescriptions": [ "Not specified, should not be used.", "String type.", "Number type.", "Integer type.", "Boolean type.", "Array type.", "Object type.", "Null type." ], "enum": [ "TYPE_UNSPECIFIED", "STRING", "NUMBER", "INTEGER", "BOOLEAN", "ARRAY", "OBJECT", "NULL" ] }, "format": { "description": "Optional. The format of the data. Any value is allowed, but most do not trigger any special functionality.", "type": "string" }, "title": { "description": "Optional. The title of the schema.", "type": "string" }, "description": { "description": "Optional. A brief description of the parameter. This could contain examples of use. Parameter description may be formatted as Markdown.", "type": "string" }, "nullable": { "description": "Optional. Indicates if the value may be null.", "type": "boolean" }, "enum": { "description": "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\"]}", "type": "array", "items": { "type": "string" } }, "items": { "description": "Optional. Schema of the elements of Type.ARRAY.", "$ref": "Schema" }, "maxItems": { "description": "Optional. Maximum number of the elements for Type.ARRAY.", "type": "string", "format": "int64" }, "minItems": { "description": "Optional. Minimum number of the elements for Type.ARRAY.", "type": "string", "format": "int64" }, "properties": { "description": "Optional. Properties of Type.OBJECT.", "type": "object", "additionalProperties": { "$ref": "Schema" } }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "type": "array", "items": { "type": "string" } }, "minProperties": { "description": "Optional. Minimum number of the properties for Type.OBJECT.", "type": "string", "format": "int64" }, "maxProperties": { "description": "Optional. Maximum number of the properties for Type.OBJECT.", "type": "string", "format": "int64" }, "minimum": { "description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER", "type": "number", "format": "double" }, "maximum": { "description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER", "type": "number", "format": "double" }, "minLength": { "description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING", "type": "string", "format": "int64" }, "maxLength": { "description": "Optional. Maximum length of the Type.STRING", "type": "string", "format": "int64" }, "pattern": { "description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.", "type": "string" }, "example": { "description": "Optional. Example of the object. Will only populated when the object is the root.", "type": "any" }, "anyOf": { "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "type": "array", "items": { "$ref": "Schema" } }, "propertyOrdering": { "description": "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.", "type": "array", "items": { "type": "string" } }, "default": { "description": "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 `default` field don't get unknown-field errors.", "type": "any" } } }, "GoogleSearchRetrieval": { "id": "GoogleSearchRetrieval", "description": "Tool to retrieve public web data for grounding, powered by Google.", "type": "object", "properties": { "dynamicRetrievalConfig": { "description": "Specifies the dynamic retrieval configuration for the given source.", "$ref": "DynamicRetrievalConfig" } } }, "DynamicRetrievalConfig": { "id": "DynamicRetrievalConfig", "description": "Describes the options to customize dynamic retrieval.", "type": "object", "properties": { "mode": { "description": "The mode of the predictor to be used in dynamic retrieval.", "type": "string", "enumDescriptions": [ "Always trigger retrieval.", "Run retrieval only when system decides it is necessary." ], "enum": [ "MODE_UNSPECIFIED", "MODE_DYNAMIC" ] }, "dynamicThreshold": { "description": "The threshold to be used in dynamic retrieval. If not set, a system default value is used.", "type": "number", "format": "float" } } }, "CodeExecution": { "id": "CodeExecution", "description": "Tool that executes code generated by the model, and automatically returns the result to the model. See also `ExecutableCode` and `CodeExecutionResult` which are only generated when using this tool.", "type": "object", "properties": {} }, "GoogleSearch": { "id": "GoogleSearch", "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "type": "object", "properties": { "timeRangeFilter": { "description": "Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa).", "$ref": "Interval" }, "searchTypes": { "description": "Optional. The set of search types to enable. If not set, web search is enabled by default.", "$ref": "SearchTypes" } } }, "Interval": { "id": "Interval", "description": "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.", "type": "object", "properties": { "startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string", "format": "google-datetime" } } }, "SearchTypes": { "id": "SearchTypes", "description": "Different types of search that can be enabled on the GoogleSearch tool.", "type": "object", "properties": { "webSearch": { "description": "Optional. Enables web search. Only text results are returned.", "$ref": "WebSearch" }, "imageSearch": { "description": "Optional. Enables image search. Image bytes are returned.", "$ref": "ImageSearch" } } }, "WebSearch": { "id": "WebSearch", "description": "Standard web search for grounding and related configurations.", "type": "object", "properties": {} }, "ImageSearch": { "id": "ImageSearch", "description": "Image search for grounding and related configurations.", "type": "object", "properties": {} }, "ComputerUse": { "id": "ComputerUse", "description": "Computer Use tool type.", "type": "object", "properties": { "environment": { "description": "Required. The environment being operated.", "type": "string", "enumDescriptions": [ "Defaults to browser.", "Operates in a web browser." ], "enum": [ "ENVIRONMENT_UNSPECIFIED", "ENVIRONMENT_BROWSER" ] }, "excludedPredefinedFunctions": { "description": "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.", "type": "array", "items": { "type": "string" } } } }, "UrlContext": { "id": "UrlContext", "description": "Tool to support URL context retrieval.", "type": "object", "properties": {} }, "FileSearch": { "id": "FileSearch", "description": "The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora. Files are imported to Semantic Retrieval corpora using the ImportFile API.", "type": "object", "properties": { "fileSearchStoreNames": { "description": "Required. The names of the file_search_stores to retrieve from. Example: `fileSearchStores/my-file-search-store-123`", "type": "array", "items": { "type": "string" } }, "topK": { "description": "Optional. The number of semantic retrieval chunks to retrieve.", "type": "integer", "format": "int32" }, "metadataFilter": { "description": "Optional. Metadata filter to apply to the semantic retrieval documents and chunks.", "type": "string" } } }, "McpServer": { "id": "McpServer", "description": "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: 6", "type": "object", "properties": { "streamableHttpTransport": { "description": "A transport that can stream HTTP requests and responses.", "$ref": "StreamableHttpTransport" }, "name": { "description": "The name of the MCPServer.", "type": "string" } } }, "StreamableHttpTransport": { "id": "StreamableHttpTransport", "description": "A transport that can stream HTTP requests and responses. Next ID: 6", "type": "object", "properties": { "url": { "description": "The full URL for the MCPServer endpoint. Example: \"https://api.example.com/mcp\"", "type": "string" }, "headers": { "description": "Optional: Fields for authentication headers, timeouts, etc., if needed.", "type": "object", "additionalProperties": { "type": "string" } }, "timeout": { "description": "HTTP timeout for regular operations.", "type": "string", "format": "google-duration" }, "sseReadTimeout": { "description": "Timeout for SSE read operations.", "type": "string", "format": "google-duration" }, "terminateOnClose": { "description": "Whether to close the client session when the transport closes.", "type": "boolean" } } }, "GoogleMaps": { "id": "GoogleMaps", "description": "The GoogleMaps Tool that provides geospatial context for the user's query.", "type": "object", "properties": { "enableWidget": { "description": "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.", "type": "boolean" } } }, "ToolConfig": { "id": "ToolConfig", "description": "The Tool configuration containing parameters for specifying `Tool` use in the request.", "type": "object", "properties": { "functionCallingConfig": { "description": "Optional. Function calling config.", "$ref": "FunctionCallingConfig" }, "retrievalConfig": { "description": "Optional. Retrieval config.", "$ref": "RetrievalConfig" }, "includeServerSideToolInvocations": { "description": "Optional. If true, the API response will include the server-side tool calls and responses within the `Content` message. This allows clients to observe the server's tool interactions.", "type": "boolean" } } }, "FunctionCallingConfig": { "id": "FunctionCallingConfig", "description": "Configuration for specifying function calling behavior.", "type": "object", "properties": { "mode": { "description": "Optional. Specifies the mode in which function calling should execute. If unspecified, the default value will be set to AUTO.", "type": "string", "enumDescriptions": [ "Unspecified function calling mode. This value should not be used.", "Default model behavior, model decides to predict either a function call or a natural language response.", "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\".", "Model will not predict any function call. Model behavior is same as when not passing any function declarations.", "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\"." ], "enum": [ "MODE_UNSPECIFIED", "AUTO", "ANY", "NONE", "VALIDATED" ] }, "allowedFunctionNames": { "description": "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.", "type": "array", "items": { "type": "string" } } } }, "RetrievalConfig": { "id": "RetrievalConfig", "description": "Retrieval config.", "type": "object", "properties": { "latLng": { "description": "Optional. The location of the user.", "$ref": "LatLng" }, "languageCode": { "description": "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).", "type": "string" } } }, "LatLng": { "id": "LatLng", "description": "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.", "type": "object", "properties": { "latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "type": "number", "format": "double" }, "longitude": { "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "type": "number", "format": "double" } } }, "SafetySetting": { "id": "SafetySetting", "description": "Safety setting, affecting the safety-blocking behavior. Passing a safety setting for a category changes the allowed probability that content is blocked.", "type": "object", "properties": { "category": { "description": "Required. The category for this setting.", "type": "string", "enumDescriptions": [ "Category is unspecified.", "**PaLM** - Negative or harmful comments targeting identity and/or protected attribute.", "**PaLM** - Content that is rude, disrespectful, or profane.", "**PaLM** - Describes scenarios depicting violence against an individual or group, or general descriptions of gore.", "**PaLM** - Contains references to sexual acts or other lewd content.", "**PaLM** - Promotes unchecked medical advice.", "**PaLM** - Dangerous content that promotes, facilitates, or encourages harmful acts.", "**Gemini** - Harassment content.", "**Gemini** - Hate speech and content.", "**Gemini** - Sexually explicit content.", "**Gemini** - Dangerous content.", "**Gemini** - Content that may be used to harm civic integrity. DEPRECATED: use enable_enhanced_civic_answers instead." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, false, true ], "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_DEROGATORY", "HARM_CATEGORY_TOXICITY", "HARM_CATEGORY_VIOLENCE", "HARM_CATEGORY_SEXUAL", "HARM_CATEGORY_MEDICAL", "HARM_CATEGORY_DANGEROUS", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_CIVIC_INTEGRITY" ] }, "threshold": { "description": "Required. Controls the probability threshold at which harm is blocked.", "type": "string", "enumDescriptions": [ "Threshold is unspecified.", "Content with NEGLIGIBLE will be allowed.", "Content with NEGLIGIBLE and LOW will be allowed.", "Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.", "All content will be allowed.", "Turn off the safety filter." ], "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ] } } }, "GenerationConfig": { "id": "GenerationConfig", "description": "Configuration options for model generation and outputs. Not all parameters are configurable for every model.", "type": "object", "properties": { "candidateCount": { "description": "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)", "type": "integer", "format": "int32" }, "stopSequences": { "description": "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 `stop_sequence`. The stop sequence will not be included as part of the response.", "type": "array", "items": { "type": "string" } }, "maxOutputTokens": { "description": "Optional. The maximum number of tokens to include in a response candidate. Note: The default value varies by model, see the `Model.output_token_limit` attribute of the `Model` returned from the `getModel` function.", "type": "integer", "format": "int32" }, "temperature": { "description": "Optional. Controls the randomness of the output. Note: The default value varies by model, see the `Model.temperature` attribute of the `Model` returned from the `getModel` function. Values can range from [0.0, 2.0].", "type": "number", "format": "float" }, "topP": { "description": "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 `Model` and is specified by the`Model.top_p` attribute returned from the `getModel` function. An empty `top_k` attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting `top_k` on requests.", "type": "number", "format": "float" }, "topK": { "description": "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 `top_k` most probable tokens. Models running with nucleus sampling don't allow top_k setting. Note: The default value varies by `Model` and is specified by the`Model.top_p` attribute returned from the `getModel` function. An empty `top_k` attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting `top_k` on requests.", "type": "integer", "format": "int32" }, "seed": { "description": "Optional. Seed used in decoding. If not set, the request uses a randomly generated seed.", "type": "integer", "format": "int32" }, "responseMimeType": { "description": "Optional. MIME type of the generated candidate text. Supported MIME types are: `text/plain`: (default) Text output. `application/json`: JSON response in the response candidates. `text/x.enum`: 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.", "type": "string" }, "responseSchema": { "description": "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 `response_mime_type` must also be set. Compatible MIME types: `application/json`: Schema for JSON response. Refer to the [JSON text generation guide](https://ai.google.dev/gemini-api/docs/json-mode) for more details.", "$ref": "Schema" }, "_responseJsonSchema": { "description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` 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 `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.", "type": "any" }, "responseJsonSchema": { "description": "Optional. An internal detail. Use `responseJsonSchema` rather than this field.", "type": "any" }, "presencePenalty": { "description": "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.", "type": "number", "format": "float" }, "frequencyPenalty": { "description": "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.", "type": "number", "format": "float" }, "responseLogprobs": { "description": "Optional. If true, export the logprobs results in response.", "type": "boolean" }, "logprobs": { "description": "Optional. Only valid if response_logprobs=True. This sets the number of top logprobs, including the chosen candidate, to return at each decoding step in the Candidate.logprobs_result. The number must be in the range of [0, 20].", "type": "integer", "format": "int32" }, "enableEnhancedCivicAnswers": { "description": "Optional. Enables enhanced civic answers. It may not be available for all models.", "type": "boolean" }, "responseModalities": { "description": "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.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default value.", "Indicates the model should return text.", "Indicates the model should return images.", "Indicates the model should return audio." ], "enum": [ "MODALITY_UNSPECIFIED", "TEXT", "IMAGE", "AUDIO" ] } }, "speechConfig": { "description": "Optional. The speech generation config.", "$ref": "SpeechConfig" }, "thinkingConfig": { "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.", "$ref": "ThinkingConfig" }, "imageConfig": { "description": "Optional. Config for image generation. An error will be returned if this field is set for models that don't support these config options.", "$ref": "ImageConfig" }, "mediaResolution": { "description": "Optional. If specified, the media resolution specified will be used.", "type": "string", "enumDescriptions": [ "Media resolution has not been set.", "Media resolution set to low (64 tokens).", "Media resolution set to medium (256 tokens).", "Media resolution set to high (zoomed reframing with 256 tokens)." ], "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", "MEDIA_RESOLUTION_MEDIUM", "MEDIA_RESOLUTION_HIGH" ] }, "responseFormat": { "description": "Optional. Configuration for the response output format. Allows specifying output configuration per modality (text, audio, image) in a flat structure.", "$ref": "ResponseFormatConfig" } } }, "SpeechConfig": { "id": "SpeechConfig", "description": "Config for speech generation and transcription.", "type": "object", "properties": { "voiceConfig": { "description": "The configuration in case of single-voice output.", "$ref": "VoiceConfig" }, "multiSpeakerVoiceConfig": { "description": "Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voice_config field.", "$ref": "MultiSpeakerVoiceConfig" }, "languageCode": { "description": "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: `de-DE`, `en-AU`, `en-GB`, `en-IN`, `en-US`, `es-US`, `fr-FR`, `hi-IN`, `pt-BR`, `ar-XA`, `es-ES`, `fr-CA`, `id-ID`, `it-IT`, `ja-JP`, `tr-TR`, `vi-VN`, `bn-IN`, `gu-IN`, `kn-IN`, `ml-IN`, `mr-IN`, `ta-IN`, `te-IN`, `nl-NL`, `ko-KR`, `cmn-CN`, `pl-PL`, `ru-RU`, and `th-TH`.", "type": "string" } } }, "VoiceConfig": { "id": "VoiceConfig", "description": "The configuration for the voice to use.", "type": "object", "properties": { "prebuiltVoiceConfig": { "description": "The configuration for the prebuilt voice to use.", "$ref": "PrebuiltVoiceConfig" } } }, "PrebuiltVoiceConfig": { "id": "PrebuiltVoiceConfig", "description": "The configuration for the prebuilt speaker to use.", "type": "object", "properties": { "voiceName": { "description": "The name of the preset voice to use.", "type": "string" } } }, "MultiSpeakerVoiceConfig": { "id": "MultiSpeakerVoiceConfig", "description": "The configuration for the multi-speaker setup.", "type": "object", "properties": { "speakerVoiceConfigs": { "description": "Required. All the enabled speaker voices.", "type": "array", "items": { "$ref": "SpeakerVoiceConfig" } } } }, "SpeakerVoiceConfig": { "id": "SpeakerVoiceConfig", "description": "The configuration for a single speaker in a multi speaker setup.", "type": "object", "properties": { "speaker": { "description": "Required. The name of the speaker to use. Should be the same as in the prompt.", "type": "string" }, "voiceConfig": { "description": "Required. The configuration for the voice to use.", "$ref": "VoiceConfig" } } }, "ThinkingConfig": { "id": "ThinkingConfig", "description": "Config for thinking features.", "type": "object", "properties": { "includeThoughts": { "description": "Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", "type": "boolean" }, "thinkingBudget": { "description": "The number of thoughts tokens that the model should generate.", "type": "integer", "format": "int32" }, "thinkingLevel": { "description": "Optional. Controls the maximum depth of the model's internal reasoning process before it produces a response. The default value is model-dependent. Refer to the [Thinking levels guide](https://ai.google.dev/gemini-api/docs/thinking#thinking-levels) for more details. Recommended for Gemini 3 or later models. Use with earlier models results in an error.", "type": "string", "enumDescriptions": [ "Default value.", "Little to no thinking.", "Low thinking level.", "Medium thinking level.", "High thinking level." ], "enum": [ "THINKING_LEVEL_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH" ] } } }, "ImageConfig": { "id": "ImageConfig", "description": "Config for image generation features.", "type": "object", "properties": { "aspectRatio": { "description": "Optional. The aspect ratio of the image to generate. Supported aspect ratios: `1:1`, `1:4`, `4:1`, `1:8`, `8:1`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, or `21:9`. If not specified, the model will choose a default aspect ratio based on any reference images provided.", "type": "string" }, "imageSize": { "description": "Optional. Specifies the size of generated images. Supported values are `512`, `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.", "type": "string" } } }, "ResponseFormatConfig": { "id": "ResponseFormatConfig", "description": "Configuration for the response output format. This is a flat object where each optional sub-field configures a specific output modality.", "type": "object", "properties": { "text": { "description": "Optional. Text output format configuration.", "$ref": "TextResponseFormat" }, "audio": { "description": "Optional. Audio output format configuration.", "$ref": "AudioResponseFormat" }, "image": { "description": "Optional. Image output format configuration.", "$ref": "ImageResponseFormat" } } }, "TextResponseFormat": { "id": "TextResponseFormat", "description": "Configuration for text output format.", "type": "object", "properties": { "mimeType": { "description": "Optional. The MIME type of the text output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "JSON output format.", "Plain text output format." ], "enum": [ "MIME_TYPE_UNSPECIFIED", "APPLICATION_JSON", "TEXT_PLAIN" ] }, "schema": { "description": "Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.", "type": "any" } } }, "AudioResponseFormat": { "id": "AudioResponseFormat", "description": "Configuration for audio output format.", "type": "object", "properties": { "mimeType": { "description": "Optional. The MIME type of the audio output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "MP3 audio format.", "OGG Opus audio format.", "Raw PCM (L16) audio format.", "WAV audio format.", "A-law audio format.", "Mu-law audio format." ], "enum": [ "MIME_TYPE_UNSPECIFIED", "AUDIO_MP3", "AUDIO_OGG_OPUS", "AUDIO_L16", "AUDIO_WAV", "AUDIO_ALAW", "AUDIO_MULAW" ] }, "delivery": { "description": "Optional. The delivery mode for the audio output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Audio data is returned inline in the response.", "Audio data is returned as a URI." ], "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ] }, "sampleRate": { "description": "Optional. Sample rate in Hz.", "type": "integer", "format": "int32" }, "bitRate": { "description": "Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).", "type": "integer", "format": "int32" } } }, "ImageResponseFormat": { "id": "ImageResponseFormat", "description": "Configuration for image output format.", "type": "object", "properties": { "mimeType": { "description": "Optional. The MIME type of the image output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "JPEG image format." ], "enum": [ "MIME_TYPE_UNSPECIFIED", "IMAGE_JPEG" ] }, "delivery": { "description": "Optional. The delivery mode for the image output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Image data is returned inline in the response.", "Image data is returned as a URI." ], "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ] }, "aspectRatio": { "description": "Optional. The aspect ratio for the image output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "1:1 aspect ratio.", "2:3 aspect ratio.", "3:2 aspect ratio.", "3:4 aspect ratio.", "4:3 aspect ratio.", "4:5 aspect ratio.", "5:4 aspect ratio.", "9:16 aspect ratio.", "16:9 aspect ratio.", "21:9 aspect ratio.", "1:8 aspect ratio.", "8:1 aspect ratio.", "1:4 aspect ratio.", "4:1 aspect ratio." ], "enum": [ "ASPECT_RATIO_UNSPECIFIED", "ASPECT_RATIO_ONE_BY_ONE", "ASPECT_RATIO_TWO_BY_THREE", "ASPECT_RATIO_THREE_BY_TWO", "ASPECT_RATIO_THREE_BY_FOUR", "ASPECT_RATIO_FOUR_BY_THREE", "ASPECT_RATIO_FOUR_BY_FIVE", "ASPECT_RATIO_FIVE_BY_FOUR", "ASPECT_RATIO_NINE_BY_SIXTEEN", "ASPECT_RATIO_SIXTEEN_BY_NINE", "ASPECT_RATIO_TWENTY_ONE_BY_NINE", "ASPECT_RATIO_ONE_BY_EIGHT", "ASPECT_RATIO_EIGHT_BY_ONE", "ASPECT_RATIO_ONE_BY_FOUR", "ASPECT_RATIO_FOUR_BY_ONE" ] }, "imageSize": { "description": "Optional. The size of the image output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "512px image size.", "1K image size.", "2K image size.", "4K image size." ], "enum": [ "IMAGE_SIZE_UNSPECIFIED", "IMAGE_SIZE_FIVE_TWELVE", "IMAGE_SIZE_ONE_K", "IMAGE_SIZE_TWO_K", "IMAGE_SIZE_FOUR_K" ] } } }, "GenerateContentResponse": { "id": "GenerateContentResponse", "description": "Response from the model supporting multiple candidate responses. Safety ratings and content filtering are reported for both prompt in `GenerateContentResponse.prompt_feedback` and for each candidate in `finish_reason` and in `safety_ratings`. 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 `prompt_feedback`) - Reports feedback on each candidate in `finish_reason` and `safety_ratings`.", "type": "object", "properties": { "candidates": { "description": "Candidate responses from the model.", "type": "array", "items": { "$ref": "Candidate" } }, "promptFeedback": { "description": "Returns the prompt's feedback related to the content filters.", "$ref": "PromptFeedback" }, "usageMetadata": { "description": "Output only. Metadata on the generation requests' token usage.", "readOnly": true, "$ref": "UsageMetadata" }, "modelVersion": { "description": "Output only. The model version used to generate the response.", "readOnly": true, "type": "string" }, "responseId": { "description": "Output only. response_id is used to identify each response.", "readOnly": true, "type": "string" }, "modelStatus": { "description": "Output only. The current model status of this model.", "readOnly": true, "$ref": "ModelStatus" } } }, "Candidate": { "id": "Candidate", "description": "A response candidate generated from the model.", "type": "object", "properties": { "index": { "description": "Output only. Index of the candidate in the list of response candidates.", "readOnly": true, "type": "integer", "format": "int32" }, "content": { "description": "Output only. Generated content returned from the model.", "readOnly": true, "$ref": "Content" }, "finishReason": { "description": "Optional. Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating tokens.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Natural stop point of the model or provided stop sequence.", "The maximum number of tokens as specified in the request was reached.", "The response candidate content was flagged for safety reasons.", "The response candidate content was flagged for recitation reasons.", "The response candidate content was flagged for using an unsupported language.", "Unknown reason.", "Token generation stopped because the content contains forbidden terms.", "Token generation stopped for potentially containing prohibited content.", "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", "The function call generated by the model is invalid.", "Token generation stopped because generated images contain safety violations.", "Image generation stopped because generated images has other prohibited content.", "Image generation stopped because of other miscellaneous issue.", "The model was expected to generate an image, but none was generated.", "Image generation stopped due to recitation.", "Model generated a tool call but no tools were enabled in the request.", "Model called too many tools consecutively, thus the system exited execution.", "Request has at least one thought signature missing.", "Finished due to malformed response.", "Request was filtered by an escalation rule." ], "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", "MAX_TOKENS", "SAFETY", "RECITATION", "LANGUAGE", "OTHER", "BLOCKLIST", "PROHIBITED_CONTENT", "SPII", "MALFORMED_FUNCTION_CALL", "IMAGE_SAFETY", "IMAGE_PROHIBITED_CONTENT", "IMAGE_OTHER", "NO_IMAGE", "IMAGE_RECITATION", "UNEXPECTED_TOOL_CALL", "TOO_MANY_TOOL_CALLS", "MISSING_THOUGHT_SIGNATURE", "MALFORMED_RESPONSE", "ESCALATION" ] }, "finishMessage": { "description": "Optional. Output only. Details the reason why the model stopped generating tokens. This is populated only when `finish_reason` is set.", "readOnly": true, "type": "string" }, "safetyRatings": { "description": "List of ratings for the safety of a response candidate. There is at most one rating per category.", "type": "array", "items": { "$ref": "SafetyRating" } }, "citationMetadata": { "description": "Output only. Citation information for model-generated candidate. This field may be populated with recitation information for any text included in the `content`. These are passages that are \"recited\" from copyrighted material in the foundational LLM's training data.", "readOnly": true, "$ref": "CitationMetadata" }, "tokenCount": { "description": "Output only. Token count for this candidate.", "readOnly": true, "type": "integer", "format": "int32" }, "groundingAttributions": { "description": "Output only. Attribution information for sources that contributed to a grounded answer. This field is populated for `GenerateAnswer` calls.", "readOnly": true, "type": "array", "items": { "$ref": "GroundingAttribution" } }, "groundingMetadata": { "description": "Output only. Grounding metadata for the candidate. This field is populated for `GenerateContent` calls.", "readOnly": true, "$ref": "GroundingMetadata" }, "avgLogprobs": { "description": "Output only. Average log probability score of the candidate.", "readOnly": true, "type": "number", "format": "double" }, "logprobsResult": { "description": "Output only. Log-likelihood scores for the response tokens and top tokens", "readOnly": true, "$ref": "LogprobsResult" }, "urlContextMetadata": { "description": "Output only. Metadata related to url context retrieval tool.", "readOnly": true, "$ref": "UrlContextMetadata" } } }, "SafetyRating": { "id": "SafetyRating", "description": "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.", "type": "object", "properties": { "category": { "description": "Required. The category for this rating.", "type": "string", "enumDescriptions": [ "Category is unspecified.", "**PaLM** - Negative or harmful comments targeting identity and/or protected attribute.", "**PaLM** - Content that is rude, disrespectful, or profane.", "**PaLM** - Describes scenarios depicting violence against an individual or group, or general descriptions of gore.", "**PaLM** - Contains references to sexual acts or other lewd content.", "**PaLM** - Promotes unchecked medical advice.", "**PaLM** - Dangerous content that promotes, facilitates, or encourages harmful acts.", "**Gemini** - Harassment content.", "**Gemini** - Hate speech and content.", "**Gemini** - Sexually explicit content.", "**Gemini** - Dangerous content.", "**Gemini** - Content that may be used to harm civic integrity. DEPRECATED: use enable_enhanced_civic_answers instead." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, false, true ], "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_DEROGATORY", "HARM_CATEGORY_TOXICITY", "HARM_CATEGORY_VIOLENCE", "HARM_CATEGORY_SEXUAL", "HARM_CATEGORY_MEDICAL", "HARM_CATEGORY_DANGEROUS", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_CIVIC_INTEGRITY" ] }, "probability": { "description": "Required. The probability of harm for this content.", "type": "string", "enumDescriptions": [ "Probability is unspecified.", "Content has a negligible chance of being unsafe.", "Content has a low chance of being unsafe.", "Content has a medium chance of being unsafe.", "Content has a high chance of being unsafe." ], "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", "LOW", "MEDIUM", "HIGH" ] }, "blocked": { "description": "Was this content blocked because of this rating?", "type": "boolean" } } }, "CitationMetadata": { "id": "CitationMetadata", "description": "A collection of source attributions for a piece of content.", "type": "object", "properties": { "citationSources": { "description": "Citations to sources for a specific response.", "type": "array", "items": { "$ref": "CitationSource" } } } }, "CitationSource": { "id": "CitationSource", "description": "A citation to a source for a portion of a specific response.", "type": "object", "properties": { "startIndex": { "description": "Optional. Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.", "type": "integer", "format": "int32" }, "endIndex": { "description": "Optional. End of the attributed segment, exclusive.", "type": "integer", "format": "int32" }, "uri": { "description": "Optional. URI that is attributed as a source for a portion of the text.", "type": "string" }, "license": { "description": "Optional. License for the GitHub project that is attributed as a source for segment. License info is required for code citations.", "type": "string" } } }, "GroundingAttribution": { "id": "GroundingAttribution", "description": "Attribution for a source that contributed to an answer.", "type": "object", "properties": { "sourceId": { "description": "Output only. Identifier for the source contributing to this attribution.", "readOnly": true, "$ref": "AttributionSourceId" }, "content": { "description": "Grounding source content that makes up this attribution.", "$ref": "Content" } } }, "AttributionSourceId": { "id": "AttributionSourceId", "description": "Identifier for the source contributing to this attribution.", "type": "object", "properties": { "groundingPassage": { "description": "Identifier for an inline passage.", "$ref": "GroundingPassageId" }, "semanticRetrieverChunk": { "description": "Identifier for a `Chunk` fetched via Semantic Retriever.", "$ref": "SemanticRetrieverChunk" } } }, "GroundingPassageId": { "id": "GroundingPassageId", "description": "Identifier for a part within a `GroundingPassage`.", "type": "object", "properties": { "passageId": { "description": "Output only. ID of the passage matching the `GenerateAnswerRequest`'s `GroundingPassage.id`.", "readOnly": true, "type": "string" }, "partIndex": { "description": "Output only. Index of the part within the `GenerateAnswerRequest`'s `GroundingPassage.content`.", "readOnly": true, "type": "integer", "format": "int32" } } }, "SemanticRetrieverChunk": { "id": "SemanticRetrieverChunk", "description": "Identifier for a `Chunk` retrieved via Semantic Retriever specified in the `GenerateAnswerRequest` using `SemanticRetrieverConfig`.", "type": "object", "properties": { "source": { "description": "Output only. Name of the source matching the request's `SemanticRetrieverConfig.source`. Example: `corpora/123` or `corpora/123/documents/abc`", "readOnly": true, "type": "string" }, "chunk": { "description": "Output only. Name of the `Chunk` containing the attributed text. Example: `corpora/123/documents/abc/chunks/xyz`", "readOnly": true, "type": "string" } } }, "GroundingMetadata": { "id": "GroundingMetadata", "description": "Metadata returned to client when grounding is enabled.", "type": "object", "properties": { "searchEntryPoint": { "description": "Optional. Google search entry for the following-up web searches.", "$ref": "SearchEntryPoint" }, "groundingChunks": { "description": "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.", "type": "array", "items": { "$ref": "GroundingChunk" } }, "groundingSupports": { "description": "List of grounding support.", "type": "array", "items": { "$ref": "GoogleAiGenerativelanguageV1betaGroundingSupport" } }, "retrievalMetadata": { "description": "Metadata related to retrieval in the grounding flow.", "$ref": "RetrievalMetadata" }, "webSearchQueries": { "description": "Web search queries for the following-up web search.", "type": "array", "items": { "type": "string" } }, "imageSearchQueries": { "description": "Image search queries used for grounding.", "type": "array", "items": { "type": "string" } }, "googleMapsWidgetContextToken": { "description": "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.", "type": "string" } } }, "SearchEntryPoint": { "id": "SearchEntryPoint", "description": "Google search entry point.", "type": "object", "properties": { "renderedContent": { "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.", "type": "string" }, "sdkBlob": { "description": "Optional. Base64 encoded JSON representing array of tuple.", "type": "string", "format": "byte" } } }, "GroundingChunk": { "id": "GroundingChunk", "description": "A `GroundingChunk` 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.", "type": "object", "properties": { "web": { "description": "Grounding chunk from the web.", "$ref": "Web" }, "image": { "description": "Optional. Grounding chunk from image search.", "$ref": "Image" }, "retrievedContext": { "description": "Optional. Grounding chunk from context retrieved by the file search tool.", "$ref": "RetrievedContext" }, "maps": { "description": "Optional. Grounding chunk from Google Maps.", "$ref": "Maps" } } }, "Web": { "id": "Web", "description": "Chunk from the web.", "type": "object", "properties": { "uri": { "description": "Output only. URI reference of the chunk.", "readOnly": true, "type": "string" }, "title": { "description": "Output only. Title of the chunk.", "readOnly": true, "type": "string" } } }, "Image": { "id": "Image", "description": "Chunk from image search.", "type": "object", "properties": { "sourceUri": { "description": "The web page URI for attribution.", "type": "string" }, "imageUri": { "description": "The image asset URL.", "type": "string" }, "title": { "description": "The title of the web page that the image is from.", "type": "string" }, "domain": { "description": "The root domain of the web page that the image is from, e.g. \"example.com\".", "type": "string" } } }, "RetrievedContext": { "id": "RetrievedContext", "description": "Chunk from context retrieved by the file search tool.", "type": "object", "properties": { "uri": { "description": "Optional. URI reference of the semantic retrieval document.", "type": "string" }, "title": { "description": "Optional. Title of the document.", "type": "string" }, "text": { "description": "Optional. Text of the chunk.", "type": "string" }, "fileSearchStore": { "description": "Optional. Name of the `FileSearchStore` containing the document. Example: `fileSearchStores/123`", "type": "string" }, "customMetadata": { "description": "Optional. User-provided metadata about the retrieved context.", "type": "array", "items": { "$ref": "GroundingChunkCustomMetadata" } }, "pageNumber": { "description": "Optional. Page number of the retrieved context, if applicable.", "type": "integer", "format": "int32" }, "mediaId": { "description": "Optional. The media blob resource name for multimodal file search results. Format: fileSearchStores/{file_search_store_id}/media/{blob_id}", "type": "string" } } }, "GroundingChunkCustomMetadata": { "id": "GroundingChunkCustomMetadata", "description": "User provided metadata about the GroundingFact.", "type": "object", "properties": { "stringValue": { "description": "Optional. The string value of the metadata.", "type": "string" }, "stringListValue": { "description": "Optional. A list of string values for the metadata.", "$ref": "GroundingChunkStringList" }, "numericValue": { "description": "Optional. The numeric value of the metadata. The expected range for this value depends on the specific `key` used.", "type": "number", "format": "float" }, "key": { "description": "The key of the metadata.", "type": "string" } } }, "GroundingChunkStringList": { "id": "GroundingChunkStringList", "description": "A list of string values.", "type": "object", "properties": { "values": { "description": "The string values of the list.", "type": "array", "items": { "type": "string" } } } }, "Maps": { "id": "Maps", "description": "A grounding chunk from Google Maps. A Maps chunk corresponds to a single place.", "type": "object", "properties": { "uri": { "description": "URI reference of the place.", "type": "string" }, "title": { "description": "Title of the place.", "type": "string" }, "text": { "description": "Text description of the place answer.", "type": "string" }, "placeId": { "description": "The ID of the place, in `places/{place_id}` format. A user can use this ID to look up that place.", "type": "string" }, "placeAnswerSources": { "description": "Sources that provide answers about the features of a given place in Google Maps.", "$ref": "PlaceAnswerSources" } } }, "PlaceAnswerSources": { "id": "PlaceAnswerSources", "description": "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.", "type": "object", "properties": { "reviewSnippets": { "description": "Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.", "type": "array", "items": { "$ref": "ReviewSnippet" } } } }, "ReviewSnippet": { "id": "ReviewSnippet", "description": "Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.", "type": "object", "properties": { "reviewId": { "description": "The ID of the review snippet.", "type": "string" }, "googleMapsUri": { "description": "A link that corresponds to the user review on Google Maps.", "type": "string" }, "title": { "description": "Title of the review.", "type": "string" } } }, "GoogleAiGenerativelanguageV1betaGroundingSupport": { "id": "GoogleAiGenerativelanguageV1betaGroundingSupport", "description": "Grounding support.", "type": "object", "properties": { "segment": { "description": "Segment of the content this support belongs to.", "$ref": "GoogleAiGenerativelanguageV1betaSegment" }, "groundingChunkIndices": { "description": "Optional. A list of indices (into 'grounding_chunk' in `response.candidate.grounding_metadata`) 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).", "type": "array", "items": { "type": "integer", "format": "int32" } }, "confidenceScores": { "description": "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.", "type": "array", "items": { "type": "number", "format": "float" } }, "renderedParts": { "description": "Output only. Indices into the `parts` field of the candidate's content. These indices specify which rendered parts are associated with this support source.", "readOnly": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "GoogleAiGenerativelanguageV1betaSegment": { "id": "GoogleAiGenerativelanguageV1betaSegment", "description": "Segment of the content.", "type": "object", "properties": { "partIndex": { "description": "The index of a Part object within its parent Content object.", "type": "integer", "format": "int32" }, "startIndex": { "description": "Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", "type": "integer", "format": "int32" }, "endIndex": { "description": "End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", "type": "integer", "format": "int32" }, "text": { "description": "The text corresponding to the segment from the response.", "type": "string" } } }, "RetrievalMetadata": { "id": "RetrievalMetadata", "description": "Metadata related to retrieval in the grounding flow.", "type": "object", "properties": { "googleSearchDynamicRetrievalScore": { "description": "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.", "type": "number", "format": "float" } } }, "LogprobsResult": { "id": "LogprobsResult", "description": "Logprobs Result", "type": "object", "properties": { "logProbabilitySum": { "description": "Sum of log probabilities for all tokens.", "type": "number", "format": "float" }, "topCandidates": { "description": "Length = total number of decoding steps.", "type": "array", "items": { "$ref": "TopCandidates" } }, "chosenCandidates": { "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", "type": "array", "items": { "$ref": "LogprobsResultCandidate" } } } }, "TopCandidates": { "id": "TopCandidates", "description": "Candidates with top log probabilities at each decoding step.", "type": "object", "properties": { "candidates": { "description": "Sorted by log probability in descending order.", "type": "array", "items": { "$ref": "LogprobsResultCandidate" } } } }, "LogprobsResultCandidate": { "id": "LogprobsResultCandidate", "description": "Candidate for the logprobs token and score.", "type": "object", "properties": { "token": { "description": "The candidate’s token string value.", "type": "string" }, "tokenId": { "description": "The candidate’s token id value.", "type": "integer", "format": "int32" }, "logProbability": { "description": "The candidate's log probability.", "type": "number", "format": "float" } } }, "UrlContextMetadata": { "id": "UrlContextMetadata", "description": "Metadata related to url context retrieval tool.", "type": "object", "properties": { "urlMetadata": { "description": "List of url context.", "type": "array", "items": { "$ref": "UrlMetadata" } } } }, "UrlMetadata": { "id": "UrlMetadata", "description": "Context of the a single url retrieval.", "type": "object", "properties": { "retrievedUrl": { "description": "Retrieved url by the tool.", "type": "string" }, "urlRetrievalStatus": { "description": "Status of the url retrieval.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Url retrieval is successful.", "Url retrieval is failed due to error.", "Url retrieval is failed because the content is behind paywall.", "Url retrieval is failed because the content is unsafe." ], "enum": [ "URL_RETRIEVAL_STATUS_UNSPECIFIED", "URL_RETRIEVAL_STATUS_SUCCESS", "URL_RETRIEVAL_STATUS_ERROR", "URL_RETRIEVAL_STATUS_PAYWALL", "URL_RETRIEVAL_STATUS_UNSAFE" ] } } }, "PromptFeedback": { "id": "PromptFeedback", "description": "A set of the feedback metadata the prompt specified in `GenerateContentRequest.content`.", "type": "object", "properties": { "blockReason": { "description": "Optional. If set, the prompt was blocked and no candidates are returned. Rephrase the prompt.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Prompt was blocked due to safety reasons. Inspect `safety_ratings` to understand which safety category blocked it.", "Prompt was blocked due to unknown reasons.", "Prompt was blocked due to the terms which are included from the terminology blocklist.", "Prompt was blocked due to prohibited content.", "Candidates blocked due to unsafe image generation content." ], "enum": [ "BLOCK_REASON_UNSPECIFIED", "SAFETY", "OTHER", "BLOCKLIST", "PROHIBITED_CONTENT", "IMAGE_SAFETY" ] }, "safetyRatings": { "description": "Ratings for safety of the prompt. There is at most one rating per category.", "type": "array", "items": { "$ref": "SafetyRating" } } } }, "UsageMetadata": { "id": "UsageMetadata", "description": "Metadata on the generation request's token usage.", "type": "object", "properties": { "promptTokenCount": { "description": "Number of tokens in the prompt. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", "type": "integer", "format": "int32" }, "cachedContentTokenCount": { "description": "Number of tokens in the cached part of the prompt (the cached content)", "type": "integer", "format": "int32" }, "candidatesTokenCount": { "description": "Total number of tokens across all the generated response candidates.", "type": "integer", "format": "int32" }, "toolUsePromptTokenCount": { "description": "Output only. Number of tokens present in tool-use prompt(s).", "readOnly": true, "type": "integer", "format": "int32" }, "thoughtsTokenCount": { "description": "Output only. Number of tokens of thoughts for thinking models.", "readOnly": true, "type": "integer", "format": "int32" }, "totalTokenCount": { "description": "Total token count for the generation request (prompt + thoughts + response candidates).", "type": "integer", "format": "int32" }, "promptTokensDetails": { "description": "Output only. List of modalities that were processed in the request input.", "readOnly": true, "type": "array", "items": { "$ref": "ModalityTokenCount" } }, "cacheTokensDetails": { "description": "Output only. List of modalities of the cached content in the request input.", "readOnly": true, "type": "array", "items": { "$ref": "ModalityTokenCount" } }, "candidatesTokensDetails": { "description": "Output only. List of modalities that were returned in the response.", "readOnly": true, "type": "array", "items": { "$ref": "ModalityTokenCount" } }, "toolUsePromptTokensDetails": { "description": "Output only. List of modalities that were processed for tool-use request inputs.", "readOnly": true, "type": "array", "items": { "$ref": "ModalityTokenCount" } }, "serviceTier": { "description": "Output only. Service tier of the request.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default service tier, which is standard.", "Standard service tier.", "Flex service tier.", "Priority service tier." ], "enum": [ "unspecified", "standard", "flex", "priority" ] } } }, "ModalityTokenCount": { "id": "ModalityTokenCount", "description": "Represents token counting info for a single modality.", "type": "object", "properties": { "modality": { "description": "The modality associated with this token count.", "type": "string", "enumDescriptions": [ "Unspecified modality.", "Plain text.", "Image.", "Video.", "Audio.", "Document, e.g. PDF." ], "enum": [ "MODALITY_UNSPECIFIED", "TEXT", "IMAGE", "VIDEO", "AUDIO", "DOCUMENT" ] }, "tokenCount": { "description": "Number of tokens.", "type": "integer", "format": "int32" } } }, "ModelStatus": { "id": "ModelStatus", "description": "The status of the underlying model. This is used to indicate the stage of the underlying model and the retirement time if applicable.", "type": "object", "properties": { "modelStage": { "description": "The stage of the underlying model.", "type": "string", "enumDescriptions": [ "Unspecified model stage.", "The underlying model is subject to lots of tunings.", "Models in this stage are for experimental purposes only.", "Models in this stage are more mature than experimental models.", "Models in this stage are considered stable and ready for production use.", "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.", "Models in this stage are deprecated. These models cannot be used.", "Models in this stage are retired. These models cannot be used." ], "enumDeprecated": [ false, true, false, false, false, false, true, false ], "enum": [ "MODEL_STAGE_UNSPECIFIED", "UNSTABLE_EXPERIMENTAL", "EXPERIMENTAL", "PREVIEW", "STABLE", "LEGACY", "DEPRECATED", "RETIRED" ] }, "retirementTime": { "description": "The time at which the model will be retired.", "type": "string", "format": "google-datetime" }, "message": { "description": "A message explaining the model status.", "type": "string" } } }, "GenerateAnswerRequest": { "id": "GenerateAnswerRequest", "description": "Request to generate a grounded answer from the `Model`.", "type": "object", "properties": { "inlinePassages": { "description": "Passages provided inline with the request.", "$ref": "GroundingPassages" }, "semanticRetriever": { "description": "Content retrieved from resources created via the Semantic Retriever API.", "$ref": "SemanticRetrieverConfig" }, "contents": { "description": "Required. The content of the current conversation with the `Model`. 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 `Content` in the list containing the question. Note: `GenerateAnswer` only supports queries in English.", "type": "array", "items": { "$ref": "Content" } }, "answerStyle": { "description": "Required. Style in which answers should be returned.", "type": "string", "enumDescriptions": [ "Unspecified answer style.", "Succinct but abstract style.", "Very brief and extractive style.", "Verbose style including extra details. The response may be formatted as a sentence, paragraph, multiple paragraphs, or bullet points, etc." ], "enum": [ "ANSWER_STYLE_UNSPECIFIED", "ABSTRACTIVE", "EXTRACTIVE", "VERBOSE" ] }, "safetySettings": { "description": "Optional. A list of unique `SafetySetting` instances for blocking unsafe content. This will be enforced on the `GenerateAnswerRequest.contents` and `GenerateAnswerResponse.candidate`. There should not be more than one setting for each `SafetyCategory` 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 `SafetyCategory` specified in the safety_settings. If there is no `SafetySetting` for a given `SafetyCategory` 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.", "type": "array", "items": { "$ref": "SafetySetting" } }, "temperature": { "description": "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.", "type": "number", "format": "float" } } }, "GroundingPassages": { "id": "GroundingPassages", "description": "A repeated list of passages.", "type": "object", "properties": { "passages": { "description": "List of passages.", "type": "array", "items": { "$ref": "GroundingPassage" } } } }, "GroundingPassage": { "id": "GroundingPassage", "description": "Passage included inline with a grounding configuration.", "type": "object", "properties": { "id": { "description": "Identifier for the passage for attributing this passage in grounded answers.", "type": "string" }, "content": { "description": "Content of the passage.", "$ref": "Content" } } }, "SemanticRetrieverConfig": { "id": "SemanticRetrieverConfig", "description": "Configuration for retrieving grounding content from a `Corpus` or `Document` created using the Semantic Retriever API.", "type": "object", "properties": { "source": { "description": "Required. Name of the resource for retrieval. Example: `corpora/123` or `corpora/123/documents/abc`.", "type": "string" }, "query": { "description": "Required. Query to use for matching `Chunk`s in the given resource by similarity.", "$ref": "Content" }, "metadataFilters": { "description": "Optional. Filters for selecting `Document`s and/or `Chunk`s from the resource.", "type": "array", "items": { "$ref": "MetadataFilter" } }, "maxChunksCount": { "description": "Optional. Maximum number of relevant `Chunk`s to retrieve.", "type": "integer", "format": "int32" }, "minimumRelevanceScore": { "description": "Optional. Minimum relevance score for retrieved relevant `Chunk`s.", "type": "number", "format": "float" } } }, "MetadataFilter": { "id": "MetadataFilter", "description": "User provided filter to limit retrieval based on `Chunk` or `Document` 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}]", "type": "object", "properties": { "key": { "description": "Required. The key of the metadata to filter on.", "type": "string" }, "conditions": { "description": "Required. The `Condition`s for the given key that will trigger this filter. Multiple `Condition`s are joined by logical ORs.", "type": "array", "items": { "$ref": "Condition" } } } }, "Condition": { "id": "Condition", "description": "Filter condition applicable to a single key.", "type": "object", "properties": { "stringValue": { "description": "The string value to filter the metadata on.", "type": "string" }, "numericValue": { "description": "The numeric value to filter the metadata on.", "type": "number", "format": "float" }, "operation": { "description": "Required. Operator applied to the given key-value pair to trigger the condition.", "type": "string", "enumDescriptions": [ "The default value. This value is unused.", "Supported by numeric.", "Supported by numeric.", "Supported by numeric & string.", "Supported by numeric.", "Supported by numeric.", "Supported by numeric & string.", "Supported by string only when `CustomMetadata` value type for the given key has a `string_list_value`.", "Supported by string only when `CustomMetadata` value type for the given key has a `string_list_value`." ], "enum": [ "OPERATOR_UNSPECIFIED", "LESS", "LESS_EQUAL", "EQUAL", "GREATER_EQUAL", "GREATER", "NOT_EQUAL", "INCLUDES", "EXCLUDES" ] } } }, "GenerateAnswerResponse": { "id": "GenerateAnswerResponse", "description": "Response from the model for a grounded answer.", "type": "object", "properties": { "answer": { "description": "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 `answerable_probability`.", "$ref": "Candidate" }, "answerableProbability": { "description": "Output only. The model's estimate of the probability that its answer is correct and grounded in the input passages. A low `answerable_probability` indicates that the answer might not be grounded in the sources. When `answerable_probability` 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. `0.5` is a good starting threshold.", "readOnly": true, "type": "number", "format": "float" }, "inputFeedback": { "description": "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 `GenerateAnswerRequest.content` - Conversation history specified by the other entries in `GenerateAnswerRequest.content` - Grounding sources (`GenerateAnswerRequest.semantic_retriever` or `GenerateAnswerRequest.inline_passages`)", "readOnly": true, "$ref": "InputFeedback" } } }, "InputFeedback": { "id": "InputFeedback", "description": "Feedback related to the input data used to answer the question, as opposed to the model-generated response to the question.", "type": "object", "properties": { "blockReason": { "description": "Optional. If set, the input was blocked and no candidates are returned. Rephrase the input.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Input was blocked due to safety reasons. Inspect `safety_ratings` to understand which safety category blocked it.", "Input was blocked due to other reasons." ], "enum": [ "BLOCK_REASON_UNSPECIFIED", "SAFETY", "OTHER" ] }, "safetyRatings": { "description": "Ratings for safety of the input. There is at most one rating per category.", "type": "array", "items": { "$ref": "SafetyRating" } } } }, "EmbedContentRequest": { "id": "EmbedContentRequest", "description": "Request containing the `Content` for the model to embed.", "type": "object", "properties": { "model": { "description": "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 `ListModels` method. Format: `models/{model}`", "type": "string" }, "content": { "description": "Required. The content to embed. Only the `parts.text` fields will be counted.", "$ref": "Content" }, "taskType": { "description": "Optional. Deprecated: Please use EmbedContentConfig.task_type instead. Optional task type for which the embeddings will be used. Not supported on earlier models (`models/embedding-001`).", "deprecated": true, "type": "string", "enumDescriptions": [ "Unset value, which will default to one of the other enum values.", "Specifies the given text is a query in a search/retrieval setting.", "Specifies the given text is a document from the corpus being searched.", "Specifies the given text will be used for STS.", "Specifies that the given text will be classified.", "Specifies that the embeddings will be used for clustering.", "Specifies that the given text will be used for question answering.", "Specifies that the given text will be used for fact verification.", "Specifies that the given text will be used for code retrieval." ], "enum": [ "TASK_TYPE_UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ] }, "title": { "description": "Optional. Deprecated: Please use EmbedContentConfig.title instead. 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.", "deprecated": true, "type": "string" }, "outputDimensionality": { "description": "Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. 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 (`models/embedding-001`).", "deprecated": true, "type": "integer", "format": "int32" }, "embedContentConfig": { "description": "Optional. Configuration for the EmbedContent request.", "$ref": "EmbedContentConfig" } } }, "EmbedContentConfig": { "id": "EmbedContentConfig", "description": "Configurations for the EmbedContent request.", "type": "object", "properties": { "title": { "description": "Optional. The title for the text.", "type": "string" }, "taskType": { "description": "Optional. The task type of the embedding.", "type": "string", "enumDescriptions": [ "Unset value, which will default to one of the other enum values.", "Specifies the given text is a query in a search/retrieval setting.", "Specifies the given text is a document from the corpus being searched.", "Specifies the given text will be used for STS.", "Specifies that the given text will be classified.", "Specifies that the embeddings will be used for clustering.", "Specifies that the given text will be used for question answering.", "Specifies that the given text will be used for fact verification.", "Specifies that the given text will be used for code retrieval." ], "enum": [ "TASK_TYPE_UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ] }, "autoTruncate": { "description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.", "type": "boolean" }, "outputDimensionality": { "description": "Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", "type": "integer", "format": "int32" }, "documentOcr": { "description": "Optional. Whether to enable OCR for document content.", "type": "boolean" }, "audioTrackExtraction": { "description": "Optional. Whether to extract audio from video content.", "type": "boolean" } } }, "EmbedContentResponse": { "id": "EmbedContentResponse", "description": "The response to an `EmbedContentRequest`.", "type": "object", "properties": { "embedding": { "description": "Output only. The embedding generated from the input content.", "readOnly": true, "$ref": "ContentEmbedding" }, "usageMetadata": { "description": "Output only. The usage metadata for the request.", "readOnly": true, "$ref": "EmbeddingUsageMetadata" } } }, "ContentEmbedding": { "id": "ContentEmbedding", "description": "A list of floats representing an embedding.", "type": "object", "properties": { "values": { "description": "The embedding values. This is for 3P users only and will not be populated for 1P calls.", "type": "array", "items": { "type": "number", "format": "float" } }, "shape": { "description": "This field stores the soft tokens tensor frame shape (e.g. [1, 1, 256, 2048]).", "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "EmbeddingUsageMetadata": { "id": "EmbeddingUsageMetadata", "description": "Metadata on the usage of the embedding request.", "type": "object", "properties": { "promptTokenCount": { "description": "Output only. Number of tokens in the prompt.", "readOnly": true, "type": "integer", "format": "int32" }, "promptTokenDetails": { "description": "Output only. List of modalities that were processed in the request input.", "readOnly": true, "type": "array", "items": { "$ref": "ModalityTokenCount" } } } }, "BatchEmbedContentsRequest": { "id": "BatchEmbedContentsRequest", "description": "Batch request to get embeddings from the model for a list of prompts.", "type": "object", "properties": { "requests": { "description": "Required. Embed requests for the batch. The model in each of these requests must match the model specified `BatchEmbedContentsRequest.model`.", "type": "array", "items": { "$ref": "EmbedContentRequest" } } } }, "BatchEmbedContentsResponse": { "id": "BatchEmbedContentsResponse", "description": "The response to a `BatchEmbedContentsRequest`.", "type": "object", "properties": { "embeddings": { "description": "Output only. The embeddings for each request, in the same order as provided in the batch request.", "readOnly": true, "type": "array", "items": { "$ref": "ContentEmbedding" } }, "usageMetadata": { "description": "Output only. The usage metadata for the request.", "readOnly": true, "$ref": "EmbeddingUsageMetadata" } } }, "CountTokensRequest": { "id": "CountTokensRequest", "description": "Counts the number of tokens in the `prompt` sent to a model. Models may tokenize text differently, so each model may return a different `token_count`.", "type": "object", "properties": { "contents": { "description": "Optional. The input given to the model as a prompt. This field is ignored when `generate_content_request` is set.", "type": "array", "items": { "$ref": "Content" } }, "generateContentRequest": { "description": "Optional. The overall input given to the `Model`. 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). `Model`s/`Content`s and `generate_content_request`s are mutually exclusive. You can either send `Model` + `Content`s or a `generate_content_request`, but never both.", "$ref": "GenerateContentRequest" } } }, "CountTokensResponse": { "id": "CountTokensResponse", "description": "A response from `CountTokens`. It returns the model's `token_count` for the `prompt`.", "type": "object", "properties": { "totalTokens": { "description": "The number of tokens that the `Model` tokenizes the `prompt` into. Always non-negative.", "type": "integer", "format": "int32" }, "cachedContentTokenCount": { "description": "Number of tokens in the cached part of the prompt (the cached content).", "type": "integer", "format": "int32" }, "promptTokensDetails": { "description": "Output only. List of modalities that were processed in the request input.", "readOnly": true, "type": "array", "items": { "$ref": "ModalityTokenCount" } }, "cacheTokensDetails": { "description": "Output only. List of modalities that were processed in the cached content.", "readOnly": true, "type": "array", "items": { "$ref": "ModalityTokenCount" } } } }, "BatchGenerateContentRequest": { "id": "BatchGenerateContentRequest", "description": "Request for a `BatchGenerateContent` operation.", "type": "object", "properties": { "batch": { "description": "Required. The batch to create.", "$ref": "GenerateContentBatch" } } }, "GenerateContentBatch": { "id": "GenerateContentBatch", "description": "A resource representing a batch of `GenerateContent` requests.", "type": "object", "properties": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "type": "string" }, "name": { "description": "Output only. Identifier. Resource name of the batch. Format: `batches/{batch_id}`.", "readOnly": true, "type": "string" }, "displayName": { "description": "Required. The user-defined name of this batch.", "type": "string" }, "inputConfig": { "description": "Required. Input configuration of the instances on which batch processing are performed.", "$ref": "InputConfig" }, "output": { "description": "Output only. The output of the batch request.", "readOnly": true, "$ref": "GenerateContentBatchOutput" }, "createTime": { "description": "Output only. The time at which the batch was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time at which the batch processing completed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The time at which the batch was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "batchStats": { "description": "Output only. Stats about the batch.", "readOnly": true, "$ref": "BatchStats" }, "state": { "description": "Output only. The state of the batch.", "readOnly": true, "type": "string", "enumDescriptions": [ "The batch state is unspecified.", "The service is preparing to run the batch.", "The batch is in progress.", "The batch completed successfully.", "The batch failed.", "The batch has been cancelled.", "The batch has expired." ], "enum": [ "BATCH_STATE_UNSPECIFIED", "BATCH_STATE_PENDING", "BATCH_STATE_RUNNING", "BATCH_STATE_SUCCEEDED", "BATCH_STATE_FAILED", "BATCH_STATE_CANCELLED", "BATCH_STATE_EXPIRED" ] }, "priority": { "description": "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.", "type": "string", "format": "int64" } } }, "InputConfig": { "id": "InputConfig", "description": "Configures the input to the batch request.", "type": "object", "properties": { "fileName": { "description": "The name of the `File` containing the input requests.", "type": "string" }, "requests": { "description": "The requests to be processed in the batch.", "$ref": "InlinedRequests" } } }, "InlinedRequests": { "id": "InlinedRequests", "description": "The requests to be processed in the batch if provided as part of the batch creation request.", "type": "object", "properties": { "requests": { "description": "Required. The requests to be processed in the batch.", "type": "array", "items": { "$ref": "InlinedRequest" } } } }, "InlinedRequest": { "id": "InlinedRequest", "description": "The request to be processed in the batch.", "type": "object", "properties": { "request": { "description": "Required. The request to be processed in the batch.", "$ref": "GenerateContentRequest" }, "metadata": { "description": "Optional. The metadata to be associated with the request.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GenerateContentBatchOutput": { "id": "GenerateContentBatchOutput", "description": "The output of a batch request. This is returned in the `BatchGenerateContentResponse` or the `GenerateContentBatch.output` field.", "type": "object", "properties": { "responsesFile": { "description": "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 `GenerateContentResponse` messages formatted as JSON. The responses will be written in the same order as the input requests.", "readOnly": true, "type": "string" }, "inlinedResponses": { "description": "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.", "readOnly": true, "$ref": "InlinedResponses" } } }, "InlinedResponses": { "id": "InlinedResponses", "description": "The responses to the requests in the batch.", "type": "object", "properties": { "inlinedResponses": { "description": "Output only. The responses to the requests in the batch.", "readOnly": true, "type": "array", "items": { "$ref": "InlinedResponse" } } } }, "InlinedResponse": { "id": "InlinedResponse", "description": "The response to a single request in the batch.", "type": "object", "properties": { "error": { "description": "Output only. The error encountered while processing the request.", "readOnly": true, "$ref": "Status" }, "response": { "description": "Output only. The response to the request.", "readOnly": true, "$ref": "GenerateContentResponse" }, "metadata": { "description": "Output only. The metadata associated with the request.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "BatchStats": { "id": "BatchStats", "description": "Stats about the batch.", "type": "object", "properties": { "requestCount": { "description": "Output only. The number of requests in the batch.", "readOnly": true, "type": "string", "format": "int64" }, "successfulRequestCount": { "description": "Output only. The number of requests that were successfully processed.", "readOnly": true, "type": "string", "format": "int64" }, "failedRequestCount": { "description": "Output only. The number of requests that failed to be processed.", "readOnly": true, "type": "string", "format": "int64" }, "pendingRequestCount": { "description": "Output only. The number of requests that are still pending processing.", "readOnly": true, "type": "string", "format": "int64" } } }, "AsyncBatchEmbedContentRequest": { "id": "AsyncBatchEmbedContentRequest", "description": "Request for an `AsyncBatchEmbedContent` operation.", "type": "object", "properties": { "batch": { "description": "Required. The batch to create.", "$ref": "EmbedContentBatch" } } }, "EmbedContentBatch": { "id": "EmbedContentBatch", "description": "A resource representing a batch of `EmbedContent` requests.", "type": "object", "properties": { "model": { "description": "Required. The name of the `Model` to use for generating the completion. Format: `models/{model}`.", "type": "string" }, "name": { "description": "Output only. Identifier. Resource name of the batch. Format: `batches/{batch_id}`.", "readOnly": true, "type": "string" }, "displayName": { "description": "Required. The user-defined name of this batch.", "type": "string" }, "inputConfig": { "description": "Required. Input configuration of the instances on which batch processing are performed.", "$ref": "InputEmbedContentConfig" }, "output": { "description": "Output only. The output of the batch request.", "readOnly": true, "$ref": "EmbedContentBatchOutput" }, "createTime": { "description": "Output only. The time at which the batch was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time at which the batch processing completed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The time at which the batch was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "batchStats": { "description": "Output only. Stats about the batch.", "readOnly": true, "$ref": "EmbedContentBatchStats" }, "state": { "description": "Output only. The state of the batch.", "readOnly": true, "type": "string", "enumDescriptions": [ "The batch state is unspecified.", "The service is preparing to run the batch.", "The batch is in progress.", "The batch completed successfully.", "The batch failed.", "The batch has been cancelled.", "The batch has expired." ], "enum": [ "BATCH_STATE_UNSPECIFIED", "BATCH_STATE_PENDING", "BATCH_STATE_RUNNING", "BATCH_STATE_SUCCEEDED", "BATCH_STATE_FAILED", "BATCH_STATE_CANCELLED", "BATCH_STATE_EXPIRED" ] }, "priority": { "description": "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.", "type": "string", "format": "int64" } } }, "InputEmbedContentConfig": { "id": "InputEmbedContentConfig", "description": "Configures the input to the batch request.", "type": "object", "properties": { "fileName": { "description": "The name of the `File` containing the input requests.", "type": "string" }, "requests": { "description": "The requests to be processed in the batch.", "$ref": "InlinedEmbedContentRequests" } } }, "InlinedEmbedContentRequests": { "id": "InlinedEmbedContentRequests", "description": "The requests to be processed in the batch if provided as part of the batch creation request.", "type": "object", "properties": { "requests": { "description": "Required. The requests to be processed in the batch.", "type": "array", "items": { "$ref": "InlinedEmbedContentRequest" } } } }, "InlinedEmbedContentRequest": { "id": "InlinedEmbedContentRequest", "description": "The request to be processed in the batch.", "type": "object", "properties": { "request": { "description": "Required. The request to be processed in the batch.", "$ref": "EmbedContentRequest" }, "metadata": { "description": "Optional. The metadata to be associated with the request.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "EmbedContentBatchOutput": { "id": "EmbedContentBatchOutput", "description": "The output of a batch request. This is returned in the `AsyncBatchEmbedContentResponse` or the `EmbedContentBatch.output` field.", "type": "object", "properties": { "responsesFile": { "description": "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 `EmbedContentResponse` messages formatted as JSON. The responses will be written in the same order as the input requests.", "readOnly": true, "type": "string" }, "inlinedResponses": { "description": "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.", "readOnly": true, "$ref": "InlinedEmbedContentResponses" } } }, "InlinedEmbedContentResponses": { "id": "InlinedEmbedContentResponses", "description": "The responses to the requests in the batch.", "type": "object", "properties": { "inlinedResponses": { "description": "Output only. The responses to the requests in the batch.", "readOnly": true, "type": "array", "items": { "$ref": "InlinedEmbedContentResponse" } } } }, "InlinedEmbedContentResponse": { "id": "InlinedEmbedContentResponse", "description": "The response to a single request in the batch.", "type": "object", "properties": { "error": { "description": "Output only. The error encountered while processing the request.", "readOnly": true, "$ref": "Status" }, "response": { "description": "Output only. The response to the request.", "readOnly": true, "$ref": "EmbedContentResponse" }, "metadata": { "description": "Output only. The metadata associated with the request.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "EmbedContentBatchStats": { "id": "EmbedContentBatchStats", "description": "Stats about the batch.", "type": "object", "properties": { "requestCount": { "description": "Output only. The number of requests in the batch.", "readOnly": true, "type": "string", "format": "int64" }, "successfulRequestCount": { "description": "Output only. The number of requests that were successfully processed.", "readOnly": true, "type": "string", "format": "int64" }, "failedRequestCount": { "description": "Output only. The number of requests that failed to be processed.", "readOnly": true, "type": "string", "format": "int64" }, "pendingRequestCount": { "description": "Output only. The number of requests that are still pending processing.", "readOnly": true, "type": "string", "format": "int64" } } }, "ListCachedContentsResponse": { "id": "ListCachedContentsResponse", "description": "Response with CachedContents list.", "type": "object", "properties": { "cachedContents": { "description": "List of cached contents.", "type": "array", "items": { "$ref": "CachedContent" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "CachedContent": { "id": "CachedContent", "description": "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.", "type": "object", "properties": { "expireTime": { "description": "Timestamp in UTC of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.", "type": "string", "format": "google-datetime" }, "ttl": { "description": "Input only. New TTL for this resource, input only.", "type": "string", "format": "google-duration" }, "name": { "description": "Output only. Identifier. The resource name referring to the cached content. Format: `cachedContents/{id}`", "readOnly": true, "type": "string" }, "displayName": { "description": "Optional. Immutable. The user-generated meaningful display name of the cached content. Maximum 128 Unicode characters.", "type": "string" }, "model": { "description": "Required. Immutable. The name of the `Model` to use for cached content Format: `models/{model}`", "type": "string" }, "systemInstruction": { "description": "Optional. Input only. Immutable. Developer set system instruction. Currently text only.", "$ref": "Content" }, "contents": { "description": "Optional. Input only. Immutable. The content to cache.", "type": "array", "items": { "$ref": "Content" } }, "tools": { "description": "Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response", "type": "array", "items": { "$ref": "Tool" } }, "toolConfig": { "description": "Optional. Input only. Immutable. Tool config. This config is shared for all tools.", "$ref": "ToolConfig" }, "createTime": { "description": "Output only. Creation time of the cache entry.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. When the cache entry was last updated in UTC time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "usageMetadata": { "description": "Output only. Metadata on the usage of the cached content.", "readOnly": true, "$ref": "CachedContentUsageMetadata" } } }, "CachedContentUsageMetadata": { "id": "CachedContentUsageMetadata", "description": "Metadata on the usage of the cached content.", "type": "object", "properties": { "totalTokenCount": { "description": "Total number of tokens that the cached content consumes.", "type": "integer", "format": "int32" } } }, "GenerateMessageRequest": { "id": "GenerateMessageRequest", "description": "Request to generate a message response from the model.", "type": "object", "properties": { "prompt": { "description": "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.", "$ref": "MessagePrompt" }, "temperature": { "description": "Optional. Controls the randomness of the output. Values can range over `[0.0,1.0]`, inclusive. A value closer to `1.0` will produce responses that are more varied, while a value closer to `0.0` will typically result in less surprising responses from the model.", "type": "number", "format": "float" }, "candidateCount": { "description": "Optional. The number of generated response messages to return. This value must be between `[1, 8]`, inclusive. If unset, this will default to `1`.", "type": "integer", "format": "int32" }, "topP": { "description": "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 `top_p`.", "type": "number", "format": "float" }, "topK": { "description": "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 `top_k` most probable tokens.", "type": "integer", "format": "int32" } } }, "MessagePrompt": { "id": "MessagePrompt", "description": "All of the structured input text passed to the model as a prompt. A `MessagePrompt` 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.", "type": "object", "properties": { "context": { "description": "Optional. Text that should be provided to the model first to ground the response. If not empty, this `context` will be given to the model first before the `examples` and `messages`. When using a `context` 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 `input_token_limit` and the input request is truncated.", "type": "string" }, "examples": { "description": "Optional. Examples of what the model should generate. This includes both user input and the response that the model should emulate. These `examples` are treated identically to conversation messages except that they take precedence over the history in `messages`: If the total input size exceeds the model's `input_token_limit` the input will be truncated. Items will be dropped from `messages` before `examples`.", "type": "array", "items": { "$ref": "Example" } }, "messages": { "description": "Required. A snapshot of the recent conversation history sorted chronologically. Turns alternate between two authors. If the total input size exceeds the model's `input_token_limit` the input will be truncated: The oldest items will be dropped from `messages`.", "type": "array", "items": { "$ref": "Message" } } } }, "Example": { "id": "Example", "description": "An input/output example used to instruct the Model. It demonstrates how the model should respond or format its response.", "type": "object", "properties": { "input": { "description": "Required. An example of an input `Message` from the user.", "$ref": "Message" }, "output": { "description": "Required. An example of what the model should output given the input.", "$ref": "Message" } } }, "Message": { "id": "Message", "description": "The base unit of structured text. A `Message` includes an `author` and the `content` of the `Message`. The `author` is used to tag messages when they are fed to the model as text.", "type": "object", "properties": { "author": { "description": "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.", "type": "string" }, "content": { "description": "Required. The text content of the structured `Message`.", "type": "string" }, "citationMetadata": { "description": "Output only. Citation information for model-generated `content` in this `Message`. If this `Message` was generated as output from the model, this field may be populated with attribution information for any text included in the `content`. This field is used only on output.", "readOnly": true, "$ref": "CitationMetadata" } } }, "GenerateMessageResponse": { "id": "GenerateMessageResponse", "description": "The response from the model. This includes candidate messages and conversation history in the form of chronologically-ordered messages.", "type": "object", "properties": { "candidates": { "description": "Candidate response messages from the model.", "type": "array", "items": { "$ref": "Message" } }, "messages": { "description": "The conversation history used by the model.", "type": "array", "items": { "$ref": "Message" } }, "filters": { "description": "A set of content filtering metadata for the prompt and response text. This indicates which `SafetyCategory`(s) blocked a candidate from this response, the lowest `HarmProbability` that triggered a block, and the HarmThreshold setting for that category.", "type": "array", "items": { "$ref": "ContentFilter" } } } }, "ContentFilter": { "id": "ContentFilter", "description": "Content filtering metadata associated with processing a single request. ContentFilter contains a reason and an optional supporting string. The reason may be unspecified.", "type": "object", "properties": { "reason": { "description": "The reason content was blocked during request processing.", "type": "string", "enumDescriptions": [ "A blocked reason was not specified.", "Content was blocked by safety settings.", "Content was blocked, but the reason is uncategorized." ], "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", "OTHER" ] }, "message": { "description": "A string that describes the filtering behavior in more detail.", "type": "string" } } }, "CountMessageTokensRequest": { "id": "CountMessageTokensRequest", "description": "Counts the number of tokens in the `prompt` sent to a model. Models may tokenize text differently, so each model may return a different `token_count`.", "type": "object", "properties": { "prompt": { "description": "Required. The prompt, whose token count is to be returned.", "$ref": "MessagePrompt" } } }, "CountMessageTokensResponse": { "id": "CountMessageTokensResponse", "description": "A response from `CountMessageTokens`. It returns the model's `token_count` for the `prompt`.", "type": "object", "properties": { "tokenCount": { "description": "The number of tokens that the `model` tokenizes the `prompt` into. Always non-negative.", "type": "integer", "format": "int32" } } }, "CreateFileRequest": { "id": "CreateFileRequest", "description": "Request for `CreateFile`.", "type": "object", "properties": { "file": { "description": "Optional. Metadata for the file to create.", "$ref": "File" } } }, "File": { "id": "File", "description": "A file uploaded to the API. Next ID: 15", "type": "object", "properties": { "videoMetadata": { "description": "Output only. Metadata for a video.", "readOnly": true, "$ref": "VideoFileMetadata" }, "name": { "description": "Immutable. Identifier. The `File` 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: `files/123-456`", "type": "string" }, "displayName": { "description": "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\"", "type": "string" }, "mimeType": { "description": "Output only. MIME type of the file.", "readOnly": true, "type": "string" }, "sizeBytes": { "description": "Output only. Size of the file in bytes.", "readOnly": true, "type": "string", "format": "int64" }, "createTime": { "description": "Output only. The timestamp of when the `File` was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The timestamp of when the `File` was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "expirationTime": { "description": "Output only. The timestamp of when the `File` will be deleted. Only set if the `File` is scheduled to expire.", "readOnly": true, "type": "string", "format": "google-datetime" }, "sha256Hash": { "description": "Output only. SHA-256 hash of the uploaded bytes.", "readOnly": true, "type": "string", "format": "byte" }, "uri": { "description": "Output only. The uri of the `File`.", "readOnly": true, "type": "string" }, "downloadUri": { "description": "Output only. The download uri of the `File`.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. Processing state of the File.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "File is being processed and cannot be used for inference yet.", "File is processed and available for inference.", "File failed processing." ], "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "ACTIVE", "FAILED" ] }, "source": { "description": "Source of the File.", "type": "string", "enumDescriptions": [ "Used if source is not specified.", "Indicates the file is uploaded by the user.", "Indicates the file is generated by Google.", "Indicates the file is a registered, i.e. a Google Cloud Storage file." ], "enum": [ "SOURCE_UNSPECIFIED", "UPLOADED", "GENERATED", "REGISTERED" ] }, "error": { "description": "Output only. Error status if File processing failed.", "readOnly": true, "$ref": "Status" } } }, "VideoFileMetadata": { "id": "VideoFileMetadata", "description": "Metadata for a video `File`.", "type": "object", "properties": { "videoDuration": { "description": "Duration of the video.", "type": "string", "format": "google-duration" } } }, "CreateFileResponse": { "id": "CreateFileResponse", "description": "Response for `CreateFile`.", "type": "object", "properties": { "file": { "description": "Metadata for the created file.", "$ref": "File" } } }, "RegisterFilesRequest": { "id": "RegisterFilesRequest", "description": "Request for `RegisterFiles`.", "type": "object", "properties": { "uris": { "description": "Required. The Google Cloud Storage URIs to register. Example: `gs://bucket/object`.", "type": "array", "items": { "type": "string" } } } }, "RegisterFilesResponse": { "id": "RegisterFilesResponse", "description": "Response for `RegisterFiles`.", "type": "object", "properties": { "files": { "description": "The registered files to be used when calling GenerateContent.", "type": "array", "items": { "$ref": "File" } } } }, "ListFilesResponse": { "id": "ListFilesResponse", "description": "Response for `ListFiles`.", "type": "object", "properties": { "files": { "description": "The list of `File`s.", "type": "array", "items": { "$ref": "File" } }, "nextPageToken": { "description": "A token that can be sent as a `page_token` into a subsequent `ListFiles` call.", "type": "string" } } }, "DownloadFileResponse": { "id": "DownloadFileResponse", "description": "Response for `DownloadFile`.", "type": "object", "properties": {} }, "GeneratedFile": { "id": "GeneratedFile", "description": "A file generated on behalf of a user.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the generated file. Example: `generatedFiles/abc-123`", "type": "string" }, "mimeType": { "description": "MIME type of the generatedFile.", "type": "string" }, "state": { "description": "Output only. The state of the GeneratedFile.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "Being generated.", "Generated and is ready for download.", "Failed to generate the GeneratedFile." ], "enum": [ "STATE_UNSPECIFIED", "GENERATING", "GENERATED", "FAILED" ] }, "error": { "description": "Error details if the GeneratedFile ends up in the STATE_FAILED state.", "$ref": "Status" } } }, "ListGeneratedFilesResponse": { "id": "ListGeneratedFilesResponse", "description": "Response for `ListGeneratedFiles`.", "type": "object", "properties": { "generatedFiles": { "description": "The list of `GeneratedFile`s.", "type": "array", "items": { "$ref": "GeneratedFile" } }, "nextPageToken": { "description": "A token that can be sent as a `page_token` into a subsequent `ListGeneratedFiles` call.", "type": "string" } } }, "Model": { "id": "Model", "description": "Information about a Generative Language Model.", "type": "object", "properties": { "name": { "description": "Required. The resource name of the `Model`. Refer to [Model variants](https://ai.google.dev/gemini-api/docs/models/gemini#model-variations) for all allowed values. Format: `models/{model}` with a `{model}` naming convention of: * \"{base_model_id}-{version}\" Examples: * `models/gemini-1.5-flash-001`", "type": "string" }, "baseModelId": { "description": "Required. The name of the base model, pass this to the generation request. Examples: * `gemini-1.5-flash`", "type": "string" }, "version": { "description": "Required. The version number of the model. This represents the major version (`1.0` or `1.5`)", "type": "string" }, "displayName": { "description": "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.", "type": "string" }, "description": { "description": "A short description of the model.", "type": "string" }, "inputTokenLimit": { "description": "Maximum number of input tokens allowed for this model.", "type": "integer", "format": "int32" }, "outputTokenLimit": { "description": "Maximum number of output tokens available for this model.", "type": "integer", "format": "int32" }, "supportedGenerationMethods": { "description": "The model's supported generation methods. The corresponding API method names are defined as Pascal case strings, such as `generateMessage` and `generateContent`.", "type": "array", "items": { "type": "string" } }, "temperature": { "description": "Controls the randomness of the output. Values can range over `[0.0,max_temperature]`, inclusive. A higher value will produce responses that are more varied, while a value closer to `0.0` 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.", "type": "number", "format": "float" }, "maxTemperature": { "description": "The maximum temperature this model can use.", "type": "number", "format": "float" }, "topP": { "description": "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 `top_p`. This value specifies default to be used by the backend while making the call to the model.", "type": "number", "format": "float" }, "topK": { "description": "For Top-k sampling. Top-k sampling considers the set of `top_k` 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 `top_k` isn't allowed as a generation parameter.", "type": "integer", "format": "int32" }, "thinking": { "description": "Whether the model supports thinking.", "type": "boolean" } } }, "ListModelsResponse": { "id": "ListModelsResponse", "description": "Response from `ListModel` containing a paginated list of Models.", "type": "object", "properties": { "models": { "description": "The returned Models.", "type": "array", "items": { "$ref": "Model" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.", "type": "string" } } }, "TunedModel": { "id": "TunedModel", "description": "A fine-tuned model created using ModelService.CreateTunedModel.", "type": "object", "properties": { "tunedModelSource": { "description": "Optional. TunedModel to use as the starting point for training the new model.", "$ref": "TunedModelSource" }, "baseModel": { "description": "Immutable. The name of the `Model` to tune. Example: `models/gemini-1.5-flash-001`", "type": "string" }, "name": { "description": "Output only. The tuned model name. A unique name will be generated on create. Example: `tunedModels/az2mb0bpw6i` 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 = `Sentence Translator` * name = `tunedModels/sentence-translator-u3b7m`", "readOnly": true, "type": "string" }, "displayName": { "description": "Optional. The name to display for this model in user interfaces. The display name must be up to 40 characters including spaces.", "type": "string" }, "description": { "description": "Optional. A short description of this model.", "type": "string" }, "temperature": { "description": "Optional. Controls the randomness of the output. Values can range over `[0.0,1.0]`, inclusive. A value closer to `1.0` will produce responses that are more varied, while a value closer to `0.0` 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.", "type": "number", "format": "float" }, "topP": { "description": "Optional. For Nucleus sampling. Nucleus sampling considers the smallest set of tokens whose probability sum is at least `top_p`. This value specifies default to be the one used by the base model while creating the model.", "type": "number", "format": "float" }, "topK": { "description": "Optional. For Top-k sampling. Top-k sampling considers the set of `top_k` 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.", "type": "integer", "format": "int32" }, "state": { "description": "Output only. The state of the tuned model.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is unused.", "The model is being created.", "The model is ready to be used.", "The model failed to be created." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED" ] }, "createTime": { "description": "Output only. The timestamp when this model was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The timestamp when this model was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "tuningTask": { "description": "Required. The tuning task that creates the tuned model.", "$ref": "TuningTask" }, "readerProjectNumbers": { "description": "Optional. List of project numbers that have read access to the tuned model.", "type": "array", "items": { "type": "string", "format": "int64" } } } }, "TunedModelSource": { "id": "TunedModelSource", "description": "Tuned model as a source for training a new model.", "type": "object", "properties": { "tunedModel": { "description": "Immutable. The name of the `TunedModel` to use as the starting point for training the new model. Example: `tunedModels/my-tuned-model`", "type": "string" }, "baseModel": { "description": "Output only. The name of the base `Model` this `TunedModel` was tuned from. Example: `models/gemini-1.5-flash-001`", "readOnly": true, "type": "string" } } }, "TuningTask": { "id": "TuningTask", "description": "Tuning tasks that create tuned models.", "type": "object", "properties": { "startTime": { "description": "Output only. The timestamp when tuning this model started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "completeTime": { "description": "Output only. The timestamp when tuning this model completed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "snapshots": { "description": "Output only. Metrics collected during tuning.", "readOnly": true, "type": "array", "items": { "$ref": "TuningSnapshot" } }, "trainingData": { "description": "Required. Input only. Immutable. The model training data.", "$ref": "Dataset" }, "hyperparameters": { "description": "Immutable. Hyperparameters controlling the tuning process. If not provided, default values will be used.", "$ref": "Hyperparameters" } } }, "TuningSnapshot": { "id": "TuningSnapshot", "description": "Record for a single tuning step.", "type": "object", "properties": { "step": { "description": "Output only. The tuning step.", "readOnly": true, "type": "integer", "format": "int32" }, "epoch": { "description": "Output only. The epoch this step was part of.", "readOnly": true, "type": "integer", "format": "int32" }, "meanLoss": { "description": "Output only. The mean loss of the training examples for this step.", "readOnly": true, "type": "number", "format": "float" }, "computeTime": { "description": "Output only. The timestamp when this metric was computed.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "Dataset": { "id": "Dataset", "description": "Dataset for training or validation.", "type": "object", "properties": { "examples": { "description": "Optional. Inline examples with simple input/output text.", "$ref": "TuningExamples" } } }, "TuningExamples": { "id": "TuningExamples", "description": "A set of tuning examples. Can be training or validation data.", "type": "object", "properties": { "examples": { "description": "The examples. Example input can be for text or discuss, but all examples in a set must be of the same type.", "type": "array", "items": { "$ref": "TuningExample" } } } }, "TuningExample": { "id": "TuningExample", "description": "A single example for tuning.", "type": "object", "properties": { "textInput": { "description": "Optional. Text model input.", "type": "string" }, "output": { "description": "Required. The expected model output.", "type": "string" } } }, "Hyperparameters": { "id": "Hyperparameters", "description": "Hyperparameters controlling the tuning process. Read more at https://ai.google.dev/docs/model_tuning_guidance", "type": "object", "properties": { "learningRate": { "description": "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.", "type": "number", "format": "float" }, "learningRateMultiplier": { "description": "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.", "type": "number", "format": "float" }, "epochCount": { "description": "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.", "type": "integer", "format": "int32" }, "batchSize": { "description": "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.", "type": "integer", "format": "int32" } } }, "ListTunedModelsResponse": { "id": "ListTunedModelsResponse", "description": "Response from `ListTunedModels` containing a paginated list of Models.", "type": "object", "properties": { "tunedModels": { "description": "The returned Models.", "type": "array", "items": { "$ref": "TunedModel" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.", "type": "string" } } }, "Permission": { "id": "Permission", "description": "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", "type": "object", "properties": { "name": { "description": "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.", "readOnly": true, "type": "string" }, "granteeType": { "description": "Optional. Immutable. The type of the grantee.", "type": "string", "enumDescriptions": [ "The default value. This value is unused.", "Represents a user. When set, you must provide email_address for the user.", "Represents a group. When set, you must provide email_address for the group.", "Represents access to everyone. No extra information is required." ], "enum": [ "GRANTEE_TYPE_UNSPECIFIED", "USER", "GROUP", "EVERYONE" ] }, "emailAddress": { "description": "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.", "type": "string" }, "role": { "description": "Required. The role granted by this permission.", "type": "string", "enumDescriptions": [ "The default value. This value is unused.", "Owner can use, update, share and delete the resource.", "Writer can use, update and share the resource.", "Reader can use the resource." ], "enum": [ "ROLE_UNSPECIFIED", "OWNER", "WRITER", "READER" ] } } }, "ListPermissionsResponse": { "id": "ListPermissionsResponse", "description": "Response from `ListPermissions` containing a paginated list of permissions.", "type": "object", "properties": { "permissions": { "description": "Returned permissions.", "type": "array", "items": { "$ref": "Permission" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.", "type": "string" } } }, "TransferOwnershipRequest": { "id": "TransferOwnershipRequest", "description": "Request to transfer the ownership of the tuned model.", "type": "object", "properties": { "emailAddress": { "description": "Required. The email address of the user to whom the tuned model is being transferred to.", "type": "string" } } }, "TransferOwnershipResponse": { "id": "TransferOwnershipResponse", "description": "Response from `TransferOwnership`.", "type": "object", "properties": {} }, "PredictRequest": { "id": "PredictRequest", "description": "Request message for PredictionService.Predict.", "type": "object", "properties": { "instances": { "description": "Required. The instances that are the input to the prediction call.", "type": "array", "items": { "type": "any" } }, "parameters": { "description": "Optional. The parameters that govern the prediction call.", "type": "any" } } }, "PredictResponse": { "id": "PredictResponse", "description": "Response message for [PredictionService.Predict].", "type": "object", "properties": { "predictions": { "description": "The outputs of the prediction call.", "type": "array", "items": { "type": "any" } } } }, "PredictLongRunningRequest": { "id": "PredictLongRunningRequest", "description": "Request message for [PredictionService.PredictLongRunning].", "type": "object", "properties": { "instances": { "description": "Required. The instances that are the input to the prediction call.", "type": "array", "items": { "type": "any" } }, "parameters": { "description": "Optional. The parameters that govern the prediction call.", "type": "any" } } }, "FileSearchStore": { "id": "FileSearchStore", "description": "A `FileSearchStore` is a collection of `Document`s.", "type": "object", "properties": { "name": { "description": "Output only. Immutable. Identifier. The `FileSearchStore` 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 `display_name` along with a 12 character random suffix. Example: `fileSearchStores/my-awesome-file-search-store-123a456b789c` If `display_name` is not provided, the name will be randomly generated.", "readOnly": true, "type": "string" }, "displayName": { "description": "Optional. The human-readable display name for the `FileSearchStore`. The display name must be no more than 512 characters in length, including spaces. Example: \"Docs on Semantic Retriever\"", "type": "string" }, "createTime": { "description": "Output only. The Timestamp of when the `FileSearchStore` was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The Timestamp of when the `FileSearchStore` was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "activeDocumentsCount": { "description": "Output only. The number of documents in the `FileSearchStore` that are active and ready for retrieval.", "readOnly": true, "type": "string", "format": "int64" }, "pendingDocumentsCount": { "description": "Output only. The number of documents in the `FileSearchStore` that are being processed.", "readOnly": true, "type": "string", "format": "int64" }, "failedDocumentsCount": { "description": "Output only. The number of documents in the `FileSearchStore` that have failed processing.", "readOnly": true, "type": "string", "format": "int64" }, "sizeBytes": { "description": "Output only. The size of raw bytes ingested into the `FileSearchStore`. This is the total size of all the documents in the `FileSearchStore`.", "readOnly": true, "type": "string", "format": "int64" }, "embeddingModel": { "description": "Optional. The embedding model to use for the `FileSearchStore`. The model's resource name. This serves as an ID for the Model to use. Format: `models/{model}`. If not specified, the default embedding model will be used.", "type": "string" } } }, "Corpus": { "id": "Corpus", "description": "A `Corpus` is a collection of `Document`s. A project can create up to 10 corpora.", "type": "object", "properties": { "name": { "description": "Output only. Immutable. Identifier. The `Corpus` 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 `display_name` along with a 12 character random suffix. Example: `corpora/my-awesome-corpora-123a456b789c`", "readOnly": true, "type": "string" }, "displayName": { "description": "Optional. The human-readable display name for the `Corpus`. The display name must be no more than 512 characters in length, including spaces. Example: \"Docs on Semantic Retriever\"", "type": "string" }, "createTime": { "description": "Output only. The Timestamp of when the `Corpus` was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The Timestamp of when the `Corpus` was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ListFileSearchStoresResponse": { "id": "ListFileSearchStoresResponse", "description": "Response from `ListFileSearchStores` containing a paginated list of `FileSearchStores`. The results are sorted by ascending `file_search_store.create_time`.", "type": "object", "properties": { "fileSearchStores": { "description": "The returned rag_stores.", "type": "array", "items": { "$ref": "FileSearchStore" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.", "type": "string" } } }, "ListCorporaResponse": { "id": "ListCorporaResponse", "description": "Response from `ListCorpora` containing a paginated list of `Corpora`. The results are sorted by ascending `corpus.create_time`.", "type": "object", "properties": { "corpora": { "description": "The returned corpora.", "type": "array", "items": { "$ref": "Corpus" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.", "type": "string" } } }, "Document": { "id": "Document", "description": "A `Document` is a collection of `Chunk`s.", "type": "object", "properties": { "name": { "description": "Immutable. Identifier. The `Document` 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 `display_name` along with a 12 character random suffix. Example: `fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c`", "type": "string" }, "displayName": { "description": "Optional. The human-readable display name for the `Document`. The display name must be no more than 512 characters in length, including spaces. Example: \"Semantic Retriever Documentation\"", "type": "string" }, "customMetadata": { "description": "Optional. User provided custom metadata stored as key-value pairs used for querying. A `Document` can have a maximum of 20 `CustomMetadata`.", "type": "array", "items": { "$ref": "CustomMetadata" } }, "updateTime": { "description": "Output only. The Timestamp of when the `Document` was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The Timestamp of when the `Document` was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. Current state of the `Document`.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "Some `Chunks` of the `Document` are being processed (embedding and vector storage).", "All `Chunks` of the `Document` is processed and available for querying.", "Some `Chunks` of the `Document` failed processing." ], "enum": [ "STATE_UNSPECIFIED", "STATE_PENDING", "STATE_ACTIVE", "STATE_FAILED" ] }, "sizeBytes": { "description": "Output only. The size of raw bytes ingested into the Document.", "readOnly": true, "type": "string", "format": "int64" }, "mimeType": { "description": "Output only. The mime type of the Document.", "readOnly": true, "type": "string" } } }, "CustomMetadata": { "id": "CustomMetadata", "description": "User provided metadata stored as key-value pairs.", "type": "object", "properties": { "stringValue": { "description": "The string value of the metadata to store.", "type": "string" }, "stringListValue": { "description": "The StringList value of the metadata to store.", "$ref": "StringList" }, "numericValue": { "description": "The numeric value of the metadata to store.", "type": "number", "format": "float" }, "key": { "description": "Required. The key of the metadata to store.", "type": "string" } } }, "StringList": { "id": "StringList", "description": "User provided string values assigned to a single metadata key.", "type": "object", "properties": { "values": { "description": "The string values of the metadata to store.", "type": "array", "items": { "type": "string" } } } }, "ListDocumentsResponse": { "id": "ListDocumentsResponse", "description": "Response from `ListDocuments` containing a paginated list of `Document`s. The `Document`s are sorted by ascending `document.create_time`.", "type": "object", "properties": { "documents": { "description": "The returned `Document`s.", "type": "array", "items": { "$ref": "Document" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages.", "type": "string" } } }, "ImportFileRequest": { "id": "ImportFileRequest", "description": "Request for `ImportFile` to import a File API file with a `FileSearchStore`.", "type": "object", "properties": { "fileName": { "description": "Required. The name of the `File` to import. Example: `files/abc-123`", "type": "string" }, "customMetadata": { "description": "Custom metadata to be associated with the file.", "type": "array", "items": { "$ref": "CustomMetadata" } }, "chunkingConfig": { "description": "Optional. Config for telling the service how to chunk the file. If not provided, the service will use default parameters.", "$ref": "ChunkingConfig" } } }, "ChunkingConfig": { "id": "ChunkingConfig", "description": "Parameters for telling the service how to chunk the file. inspired by google3/cloud/ai/platform/extension/lib/retrieval/config/chunker_config.proto", "type": "object", "properties": { "whiteSpaceConfig": { "description": "White space chunking configuration.", "$ref": "WhiteSpaceConfig" } } }, "WhiteSpaceConfig": { "id": "WhiteSpaceConfig", "description": "Configuration for a white space chunking algorithm [white space delimited].", "type": "object", "properties": { "maxTokensPerChunk": { "description": "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.", "type": "integer", "format": "int32" }, "maxOverlapTokens": { "description": "Maximum number of overlapping tokens between two adjacent chunks.", "type": "integer", "format": "int32" } } }, "UploadToFileSearchStoreRequest": { "id": "UploadToFileSearchStoreRequest", "description": "Request for `UploadToFileSearchStore`.", "type": "object", "properties": { "displayName": { "description": "Optional. Display name of the created document.", "type": "string" }, "customMetadata": { "description": "Custom metadata to be associated with the data.", "type": "array", "items": { "$ref": "CustomMetadata" } }, "chunkingConfig": { "description": "Optional. Config for telling the service how to chunk the data. If not provided, the service will use default parameters.", "$ref": "ChunkingConfig" }, "mimeType": { "description": "Optional. MIME type of the data. If not provided, it will be inferred from the uploaded content.", "type": "string" } } }, "CustomLongRunningOperation": { "id": "CustomLongRunningOperation", "type": "object", "properties": { "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "The normal, successful response of the operation. 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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "description": "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}`.", "type": "string" }, "metadata": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "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.", "type": "boolean" } } }, "DownloadMediaResponse": { "id": "DownloadMediaResponse", "description": "Response for DownloadMedia.", "type": "object", "properties": { "blob": { "description": "Output only. The blob data.", "readOnly": true, "$ref": "GdataMedia" } } }, "GdataMedia": { "id": "GdataMedia", "description": "A reference to data stored on the filesystem, on GFS or in blobstore.", "type": "object", "properties": { "contentType": { "description": "MIME type of the data", "type": "string" }, "timestamp": { "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", "type": "string", "format": "uint64" }, "token": { "description": "A unique fingerprint/version id for the media data", "type": "string" }, "length": { "description": "Size of the data, in bytes", "type": "string", "format": "int64" }, "filename": { "description": "Original file name", "type": "string" }, "referenceType": { "description": "Describes what the field reference contains.", "type": "string", "enumDescriptions": [ "Reference contains a GFS path or a local path.", "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.", "Data is included into this proto buffer", "Data should be accessed from the current service using the operation GetMedia.", "The content for this media object is stored across multiple partial media objects under the composite_media field.", "Reference points to a bigstore object", "Indicates the data is stored in diff_version_response.", "Indicates the data is stored in diff_checksums_response.", "Indicates the data is stored in diff_download_response.", "Indicates the data is stored in diff_upload_request.", "Indicates the data is stored in diff_upload_response.", "Indicates the data is stored in cosmo_binary_reference.", "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." ], "enum": [ "PATH", "BLOB_REF", "INLINE", "GET_MEDIA", "COMPOSITE_MEDIA", "BIGSTORE_REF", "DIFF_VERSION_RESPONSE", "DIFF_CHECKSUMS_RESPONSE", "DIFF_DOWNLOAD_RESPONSE", "DIFF_UPLOAD_REQUEST", "DIFF_UPLOAD_RESPONSE", "COSMO_BINARY_REFERENCE", "ARBITRARY_BYTES" ] }, "path": { "description": "Path to the data, set if reference_type is PATH", "type": "string" }, "blobRef": { "description": "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.", "deprecated": true, "type": "string", "format": "byte" }, "inline": { "description": "Media data, set if reference_type is INLINE", "type": "string", "format": "byte" }, "mediaId": { "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.", "type": "string", "format": "byte" }, "hash": { "description": "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: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.", "deprecated": true, "type": "string" }, "algorithm": { "description": "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.", "deprecated": true, "type": "string" }, "compositeMedia": { "description": "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.", "type": "array", "items": { "$ref": "CompositeMedia" } }, "bigstoreObjectRef": { "description": "Use object_id instead.", "deprecated": true, "type": "string", "format": "byte" }, "objectId": { "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF.", "$ref": "ObjectId" }, "blobstore2Info": { "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.", "$ref": "Blobstore2Info" }, "diffVersionResponse": { "description": "Set if reference_type is DIFF_VERSION_RESPONSE.", "$ref": "DiffVersionResponse" }, "diffChecksumsResponse": { "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE.", "$ref": "DiffChecksumsResponse" }, "diffDownloadResponse": { "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE.", "$ref": "DiffDownloadResponse" }, "diffUploadRequest": { "description": "Set if reference_type is DIFF_UPLOAD_REQUEST.", "$ref": "DiffUploadRequest" }, "diffUploadResponse": { "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE.", "$ref": "DiffUploadResponse" }, "contentTypeInfo": { "description": "Extended content type information provided for Scotty uploads.", "$ref": "ContentTypeInfo" }, "downloadParameters": { "description": "Parameters for a media download.", "$ref": "DownloadParameters" }, "crc32cHash": { "description": "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.", "type": "integer", "format": "uint32" }, "md5Hash": { "description": "Scotty-provided MD5 hash for an upload.", "type": "string", "format": "byte" }, "sha1Hash": { "description": "Scotty-provided SHA1 hash for an upload.", "type": "string", "format": "byte" }, "sha256Hash": { "description": "Scotty-provided SHA256 hash for an upload.", "type": "string", "format": "byte" }, "sha512Hash": { "description": "Scotty-provided SHA512 hash for an upload.", "type": "string", "format": "byte" }, "isPotentialRetry": { "description": "|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.", "type": "boolean" }, "cosmoBinaryReference": { "description": "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.", "type": "string", "format": "byte" }, "hashVerified": { "description": "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.", "type": "boolean" } } }, "CompositeMedia": { "id": "CompositeMedia", "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.", "type": "object", "properties": { "length": { "description": "Size of the data, in bytes", "type": "string", "format": "int64" }, "referenceType": { "description": "Describes what the field reference contains.", "type": "string", "enumDescriptions": [ "Reference contains a GFS path or a local path.", "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.", "Data is included into this proto buffer", "Reference points to a bigstore object", "Indicates the data is stored in cosmo_binary_reference." ], "enum": [ "PATH", "BLOB_REF", "INLINE", "BIGSTORE_REF", "COSMO_BINARY_REFERENCE" ] }, "path": { "description": "Path to the data, set if reference_type is PATH", "type": "string" }, "blobRef": { "description": "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.", "deprecated": true, "type": "string", "format": "byte" }, "inline": { "description": "Media data, set if reference_type is INLINE", "type": "string", "format": "byte" }, "objectId": { "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF.", "$ref": "ObjectId" }, "blobstore2Info": { "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.", "$ref": "Blobstore2Info" }, "cosmoBinaryReference": { "description": "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.", "type": "string", "format": "byte" }, "crc32cHash": { "description": "crc32.c hash for the payload.", "type": "integer", "format": "uint32" }, "md5Hash": { "description": "MD5 hash for the payload.", "type": "string", "format": "byte" }, "sha1Hash": { "description": "SHA-1 hash for the payload.", "type": "string", "format": "byte" } } }, "ObjectId": { "id": "ObjectId", "description": "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.", "type": "object", "properties": { "bucketName": { "description": "The name of the bucket to which this object belongs.", "type": "string" }, "objectName": { "description": "The name of the object.", "type": "string" }, "generation": { "description": "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", "type": "string", "format": "int64" } } }, "Blobstore2Info": { "id": "Blobstore2Info", "description": "Information to read/write to blobstore2.", "type": "object", "properties": { "blobId": { "description": "The blob id, e.g., /blobstore/prod/playground/scotty", "type": "string" }, "blobGeneration": { "description": "The blob generation id.", "type": "string", "format": "int64" }, "readToken": { "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.", "type": "string" }, "uploadMetadataContainer": { "description": "Metadata passed from Blobstore -\u003e 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.", "type": "string", "format": "byte" }, "downloadReadHandle": { "description": "Read handle passed from Bigstore -\u003e 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.", "type": "string", "format": "byte" }, "downloadExternalReadToken": { "description": "A serialized External Read Token passed from Bigstore -\u003e Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", "type": "string", "format": "byte" }, "uploadFragmentListCreationInfo": { "description": "A serialized Object Fragment List Creation Info passed from Bigstore -\u003e Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", "type": "string", "format": "byte" } } }, "DiffVersionResponse": { "id": "DiffVersionResponse", "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", "type": "object", "properties": { "objectVersion": { "description": "The version of the object stored at the server.", "type": "string" }, "objectSizeBytes": { "description": "The total size of the server object.", "type": "string", "format": "int64" } } }, "DiffChecksumsResponse": { "id": "DiffChecksumsResponse", "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", "type": "object", "properties": { "objectVersion": { "description": "The object version of the object the checksums are being returned for.", "type": "string" }, "objectSizeBytes": { "description": "The total size of the server object.", "type": "string", "format": "int64" }, "chunkSizeBytes": { "description": "The chunk size of checksums. Must be a multiple of 256KB.", "type": "string", "format": "int64" }, "checksumsLocation": { "description": "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.", "$ref": "CompositeMedia" }, "objectLocation": { "description": "If set, calculate the checksums based on the contents and return them to the caller.", "$ref": "CompositeMedia" } } }, "DiffDownloadResponse": { "id": "DiffDownloadResponse", "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", "type": "object", "properties": { "objectLocation": { "description": "The original object location.", "$ref": "CompositeMedia" } } }, "DiffUploadRequest": { "id": "DiffUploadRequest", "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", "type": "object", "properties": { "objectVersion": { "description": "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.", "type": "string" }, "objectInfo": { "description": "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.", "$ref": "CompositeMedia" }, "checksumsInfo": { "description": "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.", "$ref": "CompositeMedia" } } }, "DiffUploadResponse": { "id": "DiffUploadResponse", "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", "type": "object", "properties": { "objectVersion": { "description": "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.", "type": "string" }, "originalObject": { "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.", "$ref": "CompositeMedia" } } }, "ContentTypeInfo": { "id": "ContentTypeInfo", "description": "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.", "type": "object", "properties": { "bestGuess": { "description": "Scotty's best guess of what the content type of the file is.", "type": "string" }, "fromHeader": { "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.", "type": "string" }, "fromFileName": { "description": "The content type of the file derived from the file extension of the original file name used by the client.", "type": "string" }, "fromUrlPath": { "description": "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).", "type": "string" }, "fromBytes": { "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.", "type": "string" }, "fromFusionId": { "description": "The content type of the file detected by Fusion ID. go/fusionid", "type": "string" }, "fusionIdDetectionMetadata": { "description": "Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set.", "type": "string", "format": "byte" } } }, "DownloadParameters": { "id": "DownloadParameters", "description": "Parameters specific to media downloads.", "type": "object", "properties": { "allowGzipCompression": { "description": "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.", "type": "boolean" }, "ignoreRange": { "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.", "type": "boolean" } } }, "GenerateTextRequest": { "id": "GenerateTextRequest", "description": "Request to generate a text completion response from the model.", "type": "object", "properties": { "prompt": { "description": "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.", "$ref": "TextPrompt" }, "temperature": { "description": "Optional. Controls the randomness of the output. Note: The default value varies by model, see the `Model.temperature` attribute of the `Model` returned the `getModel` 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.", "type": "number", "format": "float" }, "candidateCount": { "description": "Optional. Number of generated responses to return. This value must be between [1, 8], inclusive. If unset, this will default to 1.", "type": "integer", "format": "int32" }, "maxOutputTokens": { "description": "Optional. The maximum number of tokens to include in a candidate. If unset, this will default to output_token_limit specified in the `Model` specification.", "type": "integer", "format": "int32" }, "topP": { "description": "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 `Model.top_p` attribute of the `Model` returned the `getModel` function.", "type": "number", "format": "float" }, "topK": { "description": "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 `top_k` most probable tokens. Defaults to 40. Note: The default value varies by model, see the `Model.top_k` attribute of the `Model` returned the `getModel` function.", "type": "integer", "format": "int32" }, "safetySettings": { "description": "Optional. A list of unique `SafetySetting` instances for blocking unsafe content. that will be enforced on the `GenerateTextRequest.prompt` and `GenerateTextResponse.candidates`. There should not be more than one setting for each `SafetyCategory` 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 `SafetyCategory` specified in the safety_settings. If there is no `SafetySetting` for a given `SafetyCategory` 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.", "type": "array", "items": { "$ref": "SafetySetting" } }, "stopSequences": { "description": "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.", "type": "array", "items": { "type": "string" } } } }, "TextPrompt": { "id": "TextPrompt", "description": "Text given to the model as a prompt. The Model will use this TextPrompt to Generate a text completion.", "type": "object", "properties": { "text": { "description": "Required. The prompt text.", "type": "string" } } }, "GenerateTextResponse": { "id": "GenerateTextResponse", "description": "The response from the model, including candidate completions.", "type": "object", "properties": { "candidates": { "description": "Candidate responses from the model.", "type": "array", "items": { "$ref": "TextCompletion" } }, "filters": { "description": "A set of content filtering metadata for the prompt and response text. This indicates which `SafetyCategory`(s) blocked a candidate from this response, the lowest `HarmProbability` that triggered a block, and the HarmThreshold setting for that category. This indicates the smallest change to the `SafetySettings` that would be necessary to unblock at least 1 response. The blocking is configured by the `SafetySettings` in the request (or the default `SafetySettings` of the API).", "type": "array", "items": { "$ref": "ContentFilter" } }, "safetyFeedback": { "description": "Returns any safety feedback related to content filtering.", "type": "array", "items": { "$ref": "SafetyFeedback" } } } }, "TextCompletion": { "id": "TextCompletion", "description": "Output text returned from a model.", "type": "object", "properties": { "output": { "description": "Output only. The generated text returned from the model.", "readOnly": true, "type": "string" }, "safetyRatings": { "description": "Ratings for the safety of a response. There is at most one rating per category.", "type": "array", "items": { "$ref": "SafetyRating" } }, "citationMetadata": { "description": "Output only. Citation information for model-generated `output` in this `TextCompletion`. This field may be populated with attribution information for any text included in the `output`.", "readOnly": true, "$ref": "CitationMetadata" } } }, "SafetyFeedback": { "id": "SafetyFeedback", "description": "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.", "type": "object", "properties": { "rating": { "description": "Safety rating evaluated from content.", "$ref": "SafetyRating" }, "setting": { "description": "Safety settings applied to the request.", "$ref": "SafetySetting" } } }, "EmbedTextRequest": { "id": "EmbedTextRequest", "description": "Request to get a text embedding from the model.", "type": "object", "properties": { "model": { "description": "Required. The model name to use with the format model=models/{model}.", "type": "string" }, "text": { "description": "Optional. The free-form input text that the model will turn into an embedding.", "type": "string" } } }, "EmbedTextResponse": { "id": "EmbedTextResponse", "description": "The response to a EmbedTextRequest.", "type": "object", "properties": { "embedding": { "description": "Output only. The embedding generated from the input text.", "readOnly": true, "$ref": "Embedding" } } }, "Embedding": { "id": "Embedding", "description": "A list of floats representing the embedding.", "type": "object", "properties": { "value": { "description": "The embedding values.", "type": "array", "items": { "type": "number", "format": "float" } } } }, "BatchEmbedTextRequest": { "id": "BatchEmbedTextRequest", "description": "Batch request to get a text embedding from the model.", "type": "object", "properties": { "texts": { "description": "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.", "type": "array", "items": { "type": "string" } }, "requests": { "description": "Optional. Embed requests for the batch. Only one of `texts` or `requests` can be set.", "type": "array", "items": { "$ref": "EmbedTextRequest" } } } }, "BatchEmbedTextResponse": { "id": "BatchEmbedTextResponse", "description": "The response to a EmbedTextRequest.", "type": "object", "properties": { "embeddings": { "description": "Output only. The embeddings generated from the input text.", "readOnly": true, "type": "array", "items": { "$ref": "Embedding" } } } }, "CountTextTokensRequest": { "id": "CountTextTokensRequest", "description": "Counts the number of tokens in the `prompt` sent to a model. Models may tokenize text differently, so each model may return a different `token_count`.", "type": "object", "properties": { "prompt": { "description": "Required. The free-form input text given to the model as a prompt.", "$ref": "TextPrompt" } } }, "CountTextTokensResponse": { "id": "CountTextTokensResponse", "description": "A response from `CountTextTokens`. It returns the model's `token_count` for the `prompt`.", "type": "object", "properties": { "tokenCount": { "description": "The number of tokens that the `model` tokenizes the `prompt` into. Always non-negative.", "type": "integer", "format": "int32" } } } }, "version_module": true, "rootUrl": "https://generativelanguage.googleapis.com/", "discoveryVersion": "v1", "kind": "discovery#restDescription", "basePath": "", "servicePath": "", "baseUrl": "https://generativelanguage.googleapis.com/", "version": "v1beta", "canonicalName": "Generative Language", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerName": "Google", "name": "generativelanguage", "revision": "20260603", "batchPath": "batch", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/devstorage.read_only": { "description": "View your data in Google Cloud Storage" } } } }, "mtlsRootUrl": "https://generativelanguage.mtls.googleapis.com/", "description": "The Gemini API allows developers to build generative AI applications using Gemini models. Gemini is our most capable model, built from the ground up to be multimodal. It can generalize and seamlessly understand, operate across, and combine different types of information including language, images, audio, video, and code. You can use the Gemini API for use cases like reasoning across text and images, content generation, dialogue agents, summarization and classification systems, and more." }