--- title: "POST /v1/projects/{projectsId}/locations/{locationsId}:askContexts" method: POST path: "/v1/projects/{projectsId}/locations/{locationsId}:askContexts" tags: ["projects"] --- # POST /v1/projects/{projectsId}/locations/{locationsId}:askContexts `POST /v1/projects/{projectsId}/locations/{locationsId}:askContexts` ## Request - Base URL: `https://aiplatform.googleapis.com` - URL: `https://aiplatform.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}:askContexts` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/aiplatform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/aiplatform` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Agentic Retrieval Ask API for RAG. ## Path parameters - `projectsId` string, required - `locationsId` string, required ## Request body - GoogleCloudAiplatformV1AskContextsRequest: Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts. - `query` GoogleCloudAiplatformV1RagQuery: A query to retrieve relevant contexts. - `ragRetrievalConfig` GoogleCloudAiplatformV1RagRetrievalConfig: Specifies the context retrieval config. - `filter` GoogleCloudAiplatformV1RagRetrievalConfigFilter: Config for filters. - `metadataFilter` string: Optional. String for metadata filtering. - `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. - `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` - `topK` integer: Optional. The number of contexts to retrieve. - `text` string: Optional. The query in text format to get relevant contexts. - `tools` GoogleCloudAiplatformV1Tool[]: Optional. The tools to use for AskContexts. - `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. - `computerUse` GoogleCloudAiplatformV1ToolComputerUse: A tool that enables the model to interact directly with a computer environment. - `disabledSafetyPolicies` string[]: Optional. A list of safety policies to disable for the computer use tool. - `enablePromptInjectionDetection` boolean: Optional. Whether to enable the prompt injection detection check on the computer use request. - `environment` 'ENVIRONMENT_UNSPECIFIED' | 'ENVIRONMENT_BROWSER' | 'ENVIRONMENT_MOBILE' | 'ENVIRONMENT_DESKTOP': Required. The target environment where the computer use tool operates. - `excludedPredefinedFunctions` string[]: Optional. A list of predefined functions to explicitly exclude from the model call. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included. Excluding functions allows for a more restricted action space or custom definitions for predefined functions. - `enterpriseWebSearch` GoogleCloudAiplatformV1EnterpriseWebSearch: Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. - `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. - `exaAiSearch` GoogleCloudAiplatformV1ToolExaAiSearch: ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. - `apiKey` string: Required. The API key for ExaAiSearch. - `customConfigs` object: Optional. This field can be used to pass any parameter from the Exa.ai Search API. - `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. - `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. - `description` string: Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - `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. - `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). - `additionalProperties` unknown - `anyOf` GoogleCloudAiplatformV1Schema[]: Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `default` unknown - `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. - `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. - `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"]}` - `example` unknown - `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. - `items` GoogleCloudAiplatformV1Schema (recursive) - `maxItems` string, int64: Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `maxLength` string, int64: Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `maxProperties` string, int64: Optional. If type is `OBJECT`, `max_properties` specifies the maximum 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. - `minLength` string, int64: Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `minProperties` string, int64: Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `minimum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `nullable` boolean: Optional. Indicates if the value of this field can be null. - `pattern` string: Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `properties` object: Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the 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. - `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 - `required` string[]: Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `title` string: Optional. Title for the schema. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL': Optional. Data type of the schema field. - `parametersJsonSchema` unknown - `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). - `additionalProperties` unknown - `anyOf` GoogleCloudAiplatformV1Schema[]: Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `default` unknown - `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. - `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. - `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"]}` - `example` unknown - `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. - `items` GoogleCloudAiplatformV1Schema (recursive) - `maxItems` string, int64: Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `maxLength` string, int64: Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `maxProperties` string, int64: Optional. If type is `OBJECT`, `max_properties` specifies the maximum 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. - `minLength` string, int64: Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `minProperties` string, int64: Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `minimum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `nullable` boolean: Optional. Indicates if the value of this field can be null. - `pattern` string: Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `properties` object: Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the 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. - `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 - `required` string[]: Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `title` string: Optional. Title for the schema. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL': Optional. Data type of the schema field. - `responseJsonSchema` unknown - `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. - `groundingTypes` GoogleCloudAiplatformV1GoogleMapsGroundingTypes: Defines the types of Google Maps grounding that can be enabled and their configurations. - `places` GoogleCloudAiplatformV1GoogleMapsPlaces: Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. - `routing` GoogleCloudAiplatformV1GoogleMapsRouting: Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). - `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. - `imageSearch` GoogleCloudAiplatformV1ToolGoogleSearchImageSearch: Image search for grounding and related configurations. - `webSearch` GoogleCloudAiplatformV1ToolGoogleSearchWebSearch: Standard web search for grounding and related configurations. Only text results are returned. - `googleSearchRetrieval` GoogleCloudAiplatformV1GoogleSearchRetrieval: Tool to retrieve public web data for grounding, powered by Google. - `dynamicRetrievalConfig` GoogleCloudAiplatformV1DynamicRetrievalConfig: Describes the options to customize dynamic retrieval. - `dynamicThreshold` number, float: Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - `mode` 'MODE_UNSPECIFIED' | 'MODE_DYNAMIC': The mode of the predictor to be used in dynamic retrieval. - `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. - `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 } } - `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. - `retrieval` GoogleCloudAiplatformV1Retrieval: Defines a retrieval tool that model can call to access external knowledge. - `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. - `apiAuth` GoogleCloudAiplatformV1ApiAuth: The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. - `apiKeyConfig` GoogleCloudAiplatformV1ApiAuthApiKeyConfig: The API secret. - `apiKeySecretVersion` string: Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - `apiKeyString` string: The API key string. Either this or `api_key_secret_version` must be set. - `apiSpec` 'API_SPEC_UNSPECIFIED' | 'SIMPLE_SEARCH' | 'ELASTIC_SEARCH': The API spec that the external API implements. - `authConfig` GoogleCloudAiplatformV1AuthConfig: Auth configuration to run the extension. - `apiKeyConfig` GoogleCloudAiplatformV1AuthConfigApiKeyConfig: Config for authentication with API key. - `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. - `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. - `authType` 'AUTH_TYPE_UNSPECIFIED' | 'NO_AUTH' | 'API_KEY_AUTH' | 'HTTP_BASIC_AUTH' | 'GOOGLE_SERVICE_ACCOUNT_AUTH' | 'OAUTH' | 'OIDC_AUTH': Type of auth scheme. - `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. - `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. - `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. - `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). - `elasticSearchParams` GoogleCloudAiplatformV1ExternalApiElasticSearchParams: The search parameters to use for the ELASTIC_SEARCH spec. - `index` string: The ElasticSearch index to use. - `numHits` integer: Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - `searchTemplate` string: The ElasticSearch search template to use. - `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 - `simpleSearchParams` GoogleCloudAiplatformV1ExternalApiSimpleSearchParams: The search parameters to use for SIMPLE_SEARCH spec. - `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 - `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) - `datastore` string: Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - `engine` string: Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - `filter` string: Optional. Filter strings to be passed to the search API. - `maxResults` integer: Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - `vertexRagStore` GoogleCloudAiplatformV1VertexRagStore: Retrieve from Vertex RAG Store for grounding. - `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. - `ragCorpus` string: Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - `ragFileIds` string[]: Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - `ragRetrievalConfig` GoogleCloudAiplatformV1RagRetrievalConfig: Specifies the context retrieval config. - `filter` GoogleCloudAiplatformV1RagRetrievalConfigFilter: Config for filters. - `metadataFilter` string: Optional. String for metadata filtering. - `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. - `ranking` GoogleCloudAiplatformV1RagRetrievalConfigRanking: Config for ranking and reranking. - `llmRanker` GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker: Config for LlmRanker. - … - `rankService` GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService: Config for Rank Service. - … - `topK` integer: Optional. The number of contexts to retrieve. - `similarityTopK` integer: Optional. Number of top k results to return from the selected corpora. - `vectorDistanceThreshold` number, double: Optional. Only return results with vector distance smaller than the threshold. - `urlContext` GoogleCloudAiplatformV1UrlContext: Tool to support URL context. ## Response `200` Successful response - GoogleCloudAiplatformV1AskContextsResponse: Response message for VertexRagService.AskContexts. - `contexts` GoogleCloudAiplatformV1RagContexts: Relevant contexts for one query. - `contexts` GoogleCloudAiplatformV1RagContextsContext[]: All its contexts. - `chunk` GoogleCloudAiplatformV1RagChunk: A RagChunk includes the content of a chunk of a RagFile, and associated metadata. - `chunkId` string: The ID of the chunk. - `fileId` string: The ID of the file that the chunk belongs to. - `pageSpan` GoogleCloudAiplatformV1RagChunkPageSpan: Represents where the chunk starts and ends in the document. - `firstPage` integer: Page where chunk starts in the document. Inclusive. 1-indexed. - `lastPage` integer: Page where chunk ends in the document. Inclusive. 1-indexed. - `text` string: The content of the chunk. - `score` number, double: According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant. - `sourceDisplayName` string: The file display name. - `sourceUri` string: If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. - `text` string: The text chunk. - `response` string: The Retrieval Response. ## Changes - **2026-11-06** `3aca3b348f0c`: 4 info - the security scope `https://www.googleapis.com/auth/aiplatform` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/aiplatform` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c` - **2026-10-30** `34fcc627b062`: 4 info - the security scope `https://www.googleapis.com/auth/aiplatform` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/aiplatform` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c` [Operation history](https://skmtc.dev/google/apis/aiplatform/changes/v1/projects/:projectsId/locations/:locationsId:askContexts/post.md) --- [API](https://skmtc.dev/google/apis/aiplatform.md) - [All operations](https://skmtc.dev/google/apis/aiplatform/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/aiplatform/revisions/3aca3b348f0c?raw)