Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::VertexRagService::Client (v0.61.0)

Version latest

• 0.61.0 (latest)
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::VertexRagService::Client.

Client for the VertexRagService service.

A service for retrieving relevant contexts.

Inherits

• Object

Includes

• Google::Cloud::AIPlatform::V1::VertexRagService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the VertexRagService Client class.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

Example

# Modify the configuration for all VertexRagService clients
::Google::Cloud::AIPlatform::V1::VertexRagService::Client.configure do |config|
  config.timeout = 10.0
end

#augment_prompt

def augment_prompt(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::AugmentPromptResponse
def augment_prompt(vertex_rag_store: nil, parent: nil, contents: nil, model: nil) -> ::Google::Cloud::AIPlatform::V1::AugmentPromptResponse

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

Overloads

def augment_prompt(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::AugmentPromptResponse

Pass arguments to augment_prompt via a request object, either of type AugmentPromptRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::AugmentPromptRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def augment_prompt(vertex_rag_store: nil, parent: nil, contents: nil, model: nil) -> ::Google::Cloud::AIPlatform::V1::AugmentPromptResponse

Pass arguments to augment_prompt via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• vertex_rag_store (::Google::Cloud::AIPlatform::V1::VertexRagStore, ::Hash) — Optional. Retrieves contexts from the Vertex RagStore.
• parent (::String) — 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}.
• contents (::Array<::Google::Cloud::AIPlatform::V1::Content, ::Hash>) — Optional. Input content to augment, only text format is supported for now.
• model (::Google::Cloud::AIPlatform::V1::AugmentPromptRequest::Model, ::Hash) — Optional. Metadata of the backend deployed model.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::AugmentPromptResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::AugmentPromptResponse)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::VertexRagService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::AugmentPromptRequest.new

# Call the augment_prompt method.
result = client.augment_prompt request

# The returned object is of type Google::Cloud::AIPlatform::V1::AugmentPromptResponse.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the VertexRagService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

#corroborate_content

def corroborate_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CorroborateContentResponse
def corroborate_content(parent: nil, content: nil, facts: nil, parameters: nil) -> ::Google::Cloud::AIPlatform::V1::CorroborateContentResponse

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.

Overloads

def corroborate_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CorroborateContentResponse

Pass arguments to corroborate_content via a request object, either of type CorroborateContentRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::CorroborateContentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def corroborate_content(parent: nil, content: nil, facts: nil, parameters: nil) -> ::Google::Cloud::AIPlatform::V1::CorroborateContentResponse

Pass arguments to corroborate_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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}.
• content (::Google::Cloud::AIPlatform::V1::Content, ::Hash) — Optional. Input content to corroborate, only text format is supported for now.
• facts (::Array<::Google::Cloud::AIPlatform::V1::Fact, ::Hash>) — Optional. Facts used to generate the text can also be used to corroborate the text.
• parameters (::Google::Cloud::AIPlatform::V1::CorroborateContentRequest::Parameters, ::Hash) — Optional. Parameters that can be set to override default settings per request.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::CorroborateContentResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::CorroborateContentResponse)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::VertexRagService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CorroborateContentRequest.new

# Call the corroborate_content method.
result = client.corroborate_content request

# The returned object is of type Google::Cloud::AIPlatform::V1::CorroborateContentResponse.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

• (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new VertexRagService client object.

Yields

• (config) — Configure the VertexRagService client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::VertexRagService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::VertexRagService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

• (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

• (Logger)

#retrieve_contexts

def retrieve_contexts(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::RetrieveContextsResponse
def retrieve_contexts(vertex_rag_store: nil, parent: nil, query: nil) -> ::Google::Cloud::AIPlatform::V1::RetrieveContextsResponse

Retrieves relevant contexts for a query.

Overloads

def retrieve_contexts(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::RetrieveContextsResponse

Pass arguments to retrieve_contexts via a request object, either of type RetrieveContextsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::RetrieveContextsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def retrieve_contexts(vertex_rag_store: nil, parent: nil, query: nil) -> ::Google::Cloud::AIPlatform::V1::RetrieveContextsResponse

Pass arguments to retrieve_contexts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• vertex_rag_store (::Google::Cloud::AIPlatform::V1::RetrieveContextsRequest::VertexRagStore, ::Hash) — The data source for Vertex RagStore.
• parent (::String) — 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}.
• query (::Google::Cloud::AIPlatform::V1::RagQuery, ::Hash) — Required. Single RAG retrieve query.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::RetrieveContextsResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::RetrieveContextsResponse)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::VertexRagService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::RetrieveContextsRequest.new

# Call the retrieve_contexts method.
result = client.retrieve_contexts request

# The returned object is of type Google::Cloud::AIPlatform::V1::RetrieveContextsResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)