Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::RagFile (v1.40.0)

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

A RagFile contains user data for chunking, embedding and indexing.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. The description of the RagFile.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The description of the RagFile.
Returns
  • (::String) — Optional. The description of the RagFile.

#direct_upload_source

def direct_upload_source() -> ::Google::Cloud::AIPlatform::V1::DirectUploadSource
Returns
  • (::Google::Cloud::AIPlatform::V1::DirectUploadSource) — Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

    Note: The following fields are mutually exclusive: direct_upload_source, gcs_source, google_drive_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Returns
  • (::String) — Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#file_status

def file_status() -> ::Google::Cloud::AIPlatform::V1::FileStatus
Returns

#gcs_source

def gcs_source() -> ::Google::Cloud::AIPlatform::V1::GcsSource
Returns
  • (::Google::Cloud::AIPlatform::V1::GcsSource) — Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.

    Note: The following fields are mutually exclusive: gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#google_drive_source

def google_drive_source() -> ::Google::Cloud::AIPlatform::V1::GoogleDriveSource
Returns
  • (::Google::Cloud::AIPlatform::V1::GoogleDriveSource) — Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.

    Note: The following fields are mutually exclusive: google_drive_source, gcs_source, direct_upload_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#jira_source

def jira_source() -> ::Google::Cloud::AIPlatform::V1::JiraSource
Returns
  • (::Google::Cloud::AIPlatform::V1::JiraSource) — The RagFile is imported from a Jira query.

    Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, direct_upload_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#jira_source=

def jira_source=(value) -> ::Google::Cloud::AIPlatform::V1::JiraSource
Parameter
  • value (::Google::Cloud::AIPlatform::V1::JiraSource) — The RagFile is imported from a Jira query.

    Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, direct_upload_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::AIPlatform::V1::JiraSource) — The RagFile is imported from a Jira query.

    Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, direct_upload_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the RagFile.

#share_point_sources

def share_point_sources() -> ::Google::Cloud::AIPlatform::V1::SharePointSources
Returns
  • (::Google::Cloud::AIPlatform::V1::SharePointSources) — The RagFile is imported from a SharePoint source.

    Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#share_point_sources=

def share_point_sources=(value) -> ::Google::Cloud::AIPlatform::V1::SharePointSources
Parameter
  • value (::Google::Cloud::AIPlatform::V1::SharePointSources) — The RagFile is imported from a SharePoint source.

    Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::AIPlatform::V1::SharePointSources) — The RagFile is imported from a SharePoint source.

    Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, direct_upload_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#slack_source

def slack_source() -> ::Google::Cloud::AIPlatform::V1::SlackSource
Returns
  • (::Google::Cloud::AIPlatform::V1::SlackSource) — The RagFile is imported from a Slack channel.

    Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, direct_upload_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#slack_source=

def slack_source=(value) -> ::Google::Cloud::AIPlatform::V1::SlackSource
Parameter
  • value (::Google::Cloud::AIPlatform::V1::SlackSource) — The RagFile is imported from a Slack channel.

    Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, direct_upload_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::AIPlatform::V1::SlackSource) — The RagFile is imported from a Slack channel.

    Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, direct_upload_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns