* $aiplatformService = new Google\Service\Aiplatform(...); * $locations = $aiplatformService->projects_locations; * */ class ProjectsLocations extends \Google\Service\Resource { /** * Given an input prompt, it returns augmented prompt from vertex rag store to * guide LLM towards generating grounded responses. (locations.augmentPrompt) * * @param string $parent Required. The resource name of the Location from which * to augment prompt. The users must have permission to make a call in the * project. Format: `projects/{project}/locations/{location}`. * @param GoogleCloudAiplatformV1AugmentPromptRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudAiplatformV1AugmentPromptResponse * @throws \Google\Service\Exception */ public function augmentPrompt($parent, GoogleCloudAiplatformV1AugmentPromptRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('augmentPrompt', [$params], GoogleCloudAiplatformV1AugmentPromptResponse::class); } /** * Given an input text, it returns a score that evaluates the factuality of the * text. It also extracts and returns claims from the text and provides * supporting facts. (locations.corroborateContent) * * @param string $parent Required. The resource name of the Location from which * to corroborate text. The users must have permission to make a call in the * project. Format: `projects/{project}/locations/{location}`. * @param GoogleCloudAiplatformV1CorroborateContentRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudAiplatformV1CorroborateContentResponse * @throws \Google\Service\Exception */ public function corroborateContent($parent, GoogleCloudAiplatformV1CorroborateContentRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('corroborateContent', [$params], GoogleCloudAiplatformV1CorroborateContentResponse::class); } /** * Evaluates instances based on a given metric. (locations.evaluateInstances) * * @param string $location Required. The resource name of the Location to * evaluate the instances. Format: `projects/{project}/locations/{location}` * @param GoogleCloudAiplatformV1EvaluateInstancesRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudAiplatformV1EvaluateInstancesResponse * @throws \Google\Service\Exception */ public function evaluateInstances($location, GoogleCloudAiplatformV1EvaluateInstancesRequest $postBody, $optParams = []) { $params = ['location' => $location, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('evaluateInstances', [$params], GoogleCloudAiplatformV1EvaluateInstancesResponse::class); } /** * Gets information about a location. (locations.get) * * @param string $name Resource name for the location. * @param array $optParams Optional parameters. * @return GoogleCloudLocationLocation * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudLocationLocation::class); } /** * Lists information about the supported locations for this service. * (locations.listProjectsLocations) * * @param string $name The resource that owns the locations collection, if * applicable. * @param array $optParams Optional parameters. * * @opt_param string filter A filter to narrow down results to a preferred * subset. The filtering language accepts strings like `"displayName=tokyo"`, * and is documented in more detail in [AIP-160](https://google.aip.dev/160). * @opt_param int pageSize The maximum number of results to return. If not set, * the service selects a default. * @opt_param string pageToken A page token received from the `next_page_token` * field in the response. Send that page token to receive the subsequent page. * @return GoogleCloudLocationListLocationsResponse * @throws \Google\Service\Exception */ public function listProjectsLocations($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleCloudLocationListLocationsResponse::class); } /** * Retrieves relevant contexts for a query. (locations.retrieveContexts) * * @param string $parent Required. The resource name of the Location from which * to retrieve RagContexts. The users must have permission to make a call in the * project. Format: `projects/{project}/locations/{location}`. * @param GoogleCloudAiplatformV1RetrieveContextsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudAiplatformV1RetrieveContextsResponse * @throws \Google\Service\Exception */ public function retrieveContexts($parent, GoogleCloudAiplatformV1RetrieveContextsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('retrieveContexts', [$params], GoogleCloudAiplatformV1RetrieveContextsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocations::class, 'Google_Service_Aiplatform_Resource_ProjectsLocations');