--- title: "POST /v1/{+parent}:askContexts" method: POST path: "/v1/{+parent}:askContexts" tags: ["projects"] --- # POST /v1/{+parent}:askContexts `POST /v1/{+parent}:askContexts` Agentic Retrieval Ask API for RAG. ## Path parameters - `parent` string, required ## Request body - GoogleCloudAiplatformV1AskContextsRequest — Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts. - `query` GoogleCloudAiplatformV1RagQuery — A query to retrieve relevant contexts. - `text` string — Optional. The query in text format to get relevant contexts. - `ragRetrievalConfig` GoogleCloudAiplatformV1RagRetrievalConfig — Specifies the context retrieval config. - `topK` integer — Optional. The number of contexts to retrieve. - `filter` GoogleCloudAiplatformV1RagRetrievalConfigFilter — Config for filters. - `vectorDistanceThreshold` number, double — Optional. Only returns contexts with vector distance smaller than the threshold. - `vectorSimilarityThreshold` number, double — Optional. Only returns contexts with vector similarity larger than the threshold. - `metadataFilter` string — Optional. String for metadata filtering. - `ranking` GoogleCloudAiplatformV1RagRetrievalConfigRanking — Config for ranking and reranking. - `llmRanker` GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker — Config for LlmRanker. - `modelName` string — Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - `rankService` GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService — Config for Rank Service. - `modelName` string — Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - `tools` GoogleCloudAiplatformV1Tool[] — Optional. The tools to use for AskContexts. - `googleSearchRetrieval` GoogleCloudAiplatformV1GoogleSearchRetrieval — Tool to retrieve public web data for grounding, powered by Google. - `dynamicRetrievalConfig` GoogleCloudAiplatformV1DynamicRetrievalConfig — Describes the options to customize dynamic retrieval. - `mode` 'MODE_UNSPECIFIED' | 'MODE_DYNAMIC' — The mode of the predictor to be used in dynamic retrieval. - `dynamicThreshold` number, float — Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - `computerUse` GoogleCloudAiplatformV1ToolComputerUse — Tool to support computer use. - `excludedPredefinedFunctions` string[] — Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - `enablePromptInjectionDetection` boolean — Optional. Enables the prompt injection detection check on computer-use request. - `environment` 'ENVIRONMENT_UNSPECIFIED' | 'ENVIRONMENT_BROWSER' | 'ENVIRONMENT_MOBILE' | 'ENVIRONMENT_DESKTOP' — Required. The environment being operated. - `googleMaps` GoogleCloudAiplatformV1GoogleMaps — Tool to retrieve public maps data for grounding, powered by Google. - `enableWidget` boolean — Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - `retrieval` GoogleCloudAiplatformV1Retrieval — Defines a retrieval tool that model can call to access external knowledge. - `vertexRagStore` GoogleCloudAiplatformV1VertexRagStore — Retrieve from Vertex RAG Store for grounding. - `vectorDistanceThreshold` number, double — Optional. Only return results with vector distance smaller than the threshold. - `ragRetrievalConfig` GoogleCloudAiplatformV1RagRetrievalConfig — Specifies the context retrieval config. - `topK` integer — Optional. The number of contexts to retrieve. - `filter` GoogleCloudAiplatformV1RagRetrievalConfigFilter — Config for filters. - `vectorDistanceThreshold` number, double — Optional. Only returns contexts with vector distance smaller than the threshold. - `vectorSimilarityThreshold` number, double — Optional. Only returns contexts with vector similarity larger than the threshold. - `metadataFilter` string — Optional. String for metadata filtering. - `ranking` GoogleCloudAiplatformV1RagRetrievalConfigRanking — Config for ranking and reranking. - `llmRanker` GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker — Config for LlmRanker. - … - `rankService` GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService — Config for Rank Service. - … - `ragResources` GoogleCloudAiplatformV1VertexRagStoreRagResource[] — Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - `ragFileIds` string[] — Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - `ragCorpus` string — Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - `similarityTopK` integer — Optional. Number of top k results to return from the selected corpora. - `vertexAiSearch` GoogleCloudAiplatformV1VertexAISearch — Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder - `datastore` string — Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - `dataStoreSpecs` GoogleCloudAiplatformV1VertexAISearchDataStoreSpec[] — Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - `dataStore` string — Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - `filter` string — Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - `filter` string — Optional. Filter strings to be passed to the search API. - `engine` string — Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - `maxResults` integer — Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - `disableAttribution` boolean — Optional. Deprecated. This option is no longer supported. - `externalApi` GoogleCloudAiplatformV1ExternalApi — Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. - `simpleSearchParams` GoogleCloudAiplatformV1ExternalApiSimpleSearchParams — The search parameters to use for SIMPLE_SEARCH spec. - `elasticSearchParams` GoogleCloudAiplatformV1ExternalApiElasticSearchParams — The search parameters to use for the ELASTIC_SEARCH spec. - `index` string — The ElasticSearch index to use. - `searchTemplate` string — The ElasticSearch search template to use. - `numHits` integer — Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - `apiSpec` 'API_SPEC_UNSPECIFIED' | 'SIMPLE_SEARCH' | 'ELASTIC_SEARCH' — The API spec that the external API implements. - `endpoint` string — The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - `apiAuth` GoogleCloudAiplatformV1ApiAuth — The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. - `apiKeyConfig` GoogleCloudAiplatformV1ApiAuthApiKeyConfig — The API secret. - `apiKeyString` string — The API key string. Either this or `api_key_secret_version` must be set. - `apiKeySecretVersion` string — Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - `authConfig` GoogleCloudAiplatformV1AuthConfig — Auth configuration to run the extension. - `httpBasicAuthConfig` GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig — Config for HTTP Basic Authentication. - `credentialSecret` string — Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - `oidcConfig` GoogleCloudAiplatformV1AuthConfigOidcConfig — Config for user OIDC auth. - `idToken` string — OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - `serviceAccount` string — The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - `googleServiceAccountConfig` GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig — Config for Google Service Account Authentication. - `serviceAccount` string — Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - `apiKeyConfig` GoogleCloudAiplatformV1AuthConfigApiKeyConfig — Config for authentication with API key. - `name` string — Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - `apiKeySecret` string — Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - `apiKeyString` string — Optional. The API key to be used in the request directly. - `httpElementLocation` 'HTTP_IN_UNSPECIFIED' | 'HTTP_IN_QUERY' | 'HTTP_IN_HEADER' | 'HTTP_IN_PATH' | 'HTTP_IN_BODY' | 'HTTP_IN_COOKIE' — Optional. The location of the API key. - `authType` 'AUTH_TYPE_UNSPECIFIED' | 'NO_AUTH' | 'API_KEY_AUTH' | 'HTTP_BASIC_AUTH' | 'GOOGLE_SERVICE_ACCOUNT_AUTH' | 'OAUTH' | 'OIDC_AUTH' — Type of auth scheme. - `oauthConfig` GoogleCloudAiplatformV1AuthConfigOauthConfig — Config for user oauth. - `accessToken` string — Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - `serviceAccount` string — The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - `googleSearch` GoogleCloudAiplatformV1ToolGoogleSearch — GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - `blockingConfidence` 'PHISH_BLOCK_THRESHOLD_UNSPECIFIED' | 'BLOCK_LOW_AND_ABOVE' | 'BLOCK_MEDIUM_AND_ABOVE' | 'BLOCK_HIGH_AND_ABOVE' | 'BLOCK_HIGHER_AND_ABOVE' | 'BLOCK_VERY_HIGH_AND_ABOVE' | 'BLOCK_ONLY_EXTREMELY_HIGH' — Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - `excludeDomains` string[] — Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - `searchTypes` GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes — Different types of search that can be enabled on the GoogleSearch tool. - `webSearch` GoogleCloudAiplatformV1ToolGoogleSearchWebSearch — Standard web search for grounding and related configurations. Only text results are returned. - `imageSearch` GoogleCloudAiplatformV1ToolGoogleSearchImageSearch — Image search for grounding and related configurations. - `parallelAiSearch` GoogleCloudAiplatformV1ToolParallelAiSearch — ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. - `apiKey` string — Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - `enableDataRetention` boolean — Optional. Deprecated: Use `enable_zero_data_retention` instead. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used. - `enableZeroDataRetention` boolean — Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used. - `customConfigs` object — Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - `urlContext` GoogleCloudAiplatformV1UrlContext — Tool to support URL context. - `functionDeclarations` GoogleCloudAiplatformV1FunctionDeclaration[] — Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - `parametersJsonSchema` unknown - `responseJsonSchema` unknown - `name` string — Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. - `description` string — Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - `parameters` GoogleCloudAiplatformV1Schema — Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). - `propertyOrdering` string[] — Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - `minimum` number, double — Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `pattern` string — Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `additionalProperties` unknown - `title` string — Optional. Title for the schema. - `defs` object — Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - `anyOf` GoogleCloudAiplatformV1Schema[] — Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `items` GoogleCloudAiplatformV1Schema — recursive - `default` unknown - `minProperties` string, int64 — Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `maximum` number, double — Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - `minItems` string, int64 — Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - `enum` string[] — Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - `maxItems` string, int64 — Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `format` string — Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - `example` unknown - `nullable` boolean — Optional. Indicates if the value of this field can be null. - `properties` object — Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - `minLength` string, int64 — Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `ref` string — Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - `description` string — Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. - `maxProperties` string, int64 — Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - `required` string[] — Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL' — Optional. Data type of the schema field. - `maxLength` string, int64 — Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `response` GoogleCloudAiplatformV1Schema — Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). - `propertyOrdering` string[] — Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - `minimum` number, double — Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `pattern` string — Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `additionalProperties` unknown - `title` string — Optional. Title for the schema. - `defs` object — Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - `anyOf` GoogleCloudAiplatformV1Schema[] — Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `items` GoogleCloudAiplatformV1Schema — recursive - `default` unknown - `minProperties` string, int64 — Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `maximum` number, double — Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - `minItems` string, int64 — Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - `enum` string[] — Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - `maxItems` string, int64 — Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `format` string — Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - `example` unknown - `nullable` boolean — Optional. Indicates if the value of this field can be null. - `properties` object — Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - `minLength` string, int64 — Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `ref` string — Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - `description` string — Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. - `maxProperties` string, int64 — Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - `required` string[] — Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL' — Optional. Data type of the schema field. - `maxLength` string, int64 — Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `behavior` 'UNSPECIFIED' | 'BLOCKING' | 'NON_BLOCKING' — Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. - `exaAiSearch` GoogleCloudAiplatformV1ToolExaAiSearch — ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. - `customConfigs` object — Optional. This field can be used to pass any parameter from the Exa.ai Search API. - `apiKey` string — Required. The API key for ExaAiSearch. - `enterpriseWebSearch` GoogleCloudAiplatformV1EnterpriseWebSearch — Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. - `excludeDomains` string[] — Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - `blockingConfidence` 'PHISH_BLOCK_THRESHOLD_UNSPECIFIED' | 'BLOCK_LOW_AND_ABOVE' | 'BLOCK_MEDIUM_AND_ABOVE' | 'BLOCK_HIGH_AND_ABOVE' | 'BLOCK_HIGHER_AND_ABOVE' | 'BLOCK_VERY_HIGH_AND_ABOVE' | 'BLOCK_ONLY_EXTREMELY_HIGH' — Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - `codeExecution` GoogleCloudAiplatformV1ToolCodeExecution — Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/aiplatform.md) · [All operations](https://skmtc.net/google/apis/aiplatform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/aiplatform/versions/b608d71b91f0/schema)