Save Source

1. After logging into the Kuika platform, open the project you will work on from the “Apps” screen.

2. While in the “UI Design” module, open the “Properties” panel on the right side.
3. Select “Initial Actions → Searching → Save Source” from the “+ADD ACTION” drop-down menu.

4. Then configure the following fields:

• Source Type: Specifies the type of the source. One of Google Drive, AWS S3 and Manual source types must be selected.
• Name: The identifying name given to the source.‍
• Update Interval In Hour: Specifies how often the source will be synchronized, in hours.

1. Click on the drop-down menu “+ ADD OPTIONAL PARAMETER” (1).
2. Configure the following parameters from the drop-down menu:

• Collection Name: Specifies the name of the database or a collection and defines the structure in which the data is stored. For example, in a NoSQL database this is the name of the collection where the data is grouped.
• Correlation ID: A unique ID associated with a transaction or user session. It is used for tracking and correlating transactions and events. For example, it can be used to track the response of an API call or to associate an error message with a specific process.

      3. Then click “SAVE” (2) to complete the configuration process.

To use Google Drive, the user must use Google Console with an authorized account.

1. Creating and Selecting Projects:

• On the Console page, you can create a new project or select an existing project from the dropdown menu next to the banner.

• If the resource to be added is in the drive area of an organization's account, the project must be derived from this organization. You must fill in the organization and location information.

2. Google Drive API Activation:

• Access the “APIs & Services” screen from the search at the top of the page and activate the Google Drive API.

3. Service Account Creation and Access:

• Access the “IAM & Admin” screen.

• Create a new Service Account if necessary.

• Fill in the service account information and select “Viewer” from the role list.

4. Key Creation:

• Go to the “Manage Keys” option next to the Service Account section you created, click the “Create New Key” button and create a key in JSON format.

• Record private_key, client_email and token_uri information from the downloaded JSON file. Resources can be added through this information. Private key information should be added including BEGIN and END PRIVATE KEY fields.

5. Getting FileID and FolderID:

• Copy the sharing link of your file in Google Drive.
• The file ID (fileID) and folder ID (folderID) in the link should be used for action.

6. Define Save Source:

• To add a source from Google Drive, the following parameters must be filled in:some text
  • Source Type → Google Drive
  • Name → File name
  • Update Interval in Hour → Allows you to choose how many hours synchronization will be done.
  • Information such as Client Email, Private Key, Token Uri, Folder Id, File Id is retrieved from the JSON file.

For Amazon S3 usage, an account with read access to S3 is required. You can create a new IAM User for this.

1. Creating IAM User:

• Go to the IAM section and click the “Add Users” button.
• Specify the user name and proceed with “Next”.

• Assign the AmazonS3ReadOnlyAccess policy from the “Attach policies directly” option.

• After creating the user, create an Access Key from the Security Credentials screen.

2. Access Key Registration:

• Save the generated Access Key and Secret Access Key information somewhere.

This information is only seen once.

3. Define Save Source:

• The following parameters must be filled in to add a source from Amazon S3:some text
  • Source Type → AWS
  • Name → File name
  • Update Interval in Hour → Allows you to choose how many hours synchronization will be done.
  • awsAccessKeyId, awsSecretAccessKey, bucketName, S3uri information is required.

Manual upload allows uploading files in Base64 format.

1. Convert to Base64 Format:
   • You can convert your file to Base64 format using an online site (for example, https://base64.guru/converter/encode/file).
2. Defining Save Source:
   • The following parameters must be filled in for manual upload:
     • Source Type → Manual
     • Name → File name
     • Update Interval in Hour → Allows you to choose how often to synchronize.
     • Base64 Content → Specifies the file content in Base64 format.

Getting and Using Folder Id and File Id Parameters in Google Drive Save Source Action

1. Getting File IDs in Google Drive
   • In Google Drive, right-click on the file inserted into a folder and click Share > Share.
   • On the screen that opens, make sure that the service account user has access to view it and click Copy Link.
   • Paste the copied link somewhere. You can get the fileId from the part marked in red. This is the fileId you will use in the action.
2. Example link: https://drive.google.com/file/d/1vNG371Q2ZAkC0X7e8AHm2lftTMRSqWO_/view?usp=sharing
3. The field marked in bold here: fileId
   • Likewise, to get the folderId in Drive, you can use the link to the folder: https://drive.google.com/drive/folders/18V8ZSYTNE8T_gKum3ZVUK5wHZQM3s2aa
   • The field marked in bold here: folderId

Creating a Save Source Action in the Interface

Add a Button element from the Elements panel on the left side of the UI Design module and define the Save Source action in the onClick action of this button.

Parameters:

• Source Type → Google Drive
• Name → Name of the file (set by the user)
• Update Interval in Hour → 1 (This specifies how many hours the Quadrant system will synchronize the file.)
• Client Email → test-652@vector-search-test-443209.iam.gserviceaccount.com (In Google Drive environment, service account email address with viewing authorization)
• Private Key → -----BEGIN PRIVATE KEY-----\n ....... \n-----END PRIVATE KEY-----\n (private key information in the JSON file downloaded while preparing the Google Drive environment)
• Token Uri → https://oauth2.googleapis.com/token (token URI in the JSON file downloaded while preparing the Google Drive environment)
• Folder Id → 18V8ZSYTNE8T_gKum3ZVUK5wHZQM3s2aa (folderId shown above)
• File Id → 1vNG371Q2ZAkC0X7e8AHm2lftTMRSqWO_ (fileId shown above)
• Collection Name (optional) → googledrive1 (This sets a collection name starting with the username in the Qdrant system. If not entered, it is taken as DefaultCollection).
• Correlation Id (optional) → correlationId (This parameter allows the record to be added again if the source needs to be updated or if information such as privateKey, clientEmail changes.)

Creating Amazon S3 Save Source Action

Parameters

• Source Type → AWS
• Name → Name of the file (determined by the user)
• Update Interval in Hour → 1 (This specifies how many hours the Qdrant system will synchronize the file.)
• awsAccessKeyId → key (In the AWS environment, the steps to get this key are shown.)
• awsSecretAccessKey → key (In AWS environment, the steps to get this key are shown.)
• Bucket Name → test-bucket-vector-search (In the AWS environment, the steps to get this bucket name are shown)
• S3uri → s3://test-bucket-vector-search/s3Folder/ (In AWS environment, the steps to get this S3 uri are shown)
• Collection Name (optional) → googledrive1
• Correlation Id (optional) → correlationId

Creating a Manual Save Source Action

Parameters

• Source Type → Manual
• Name → Name of the file (determined by the user)
• Update Interval in Hour → 1 (This specifies how many hours the Qdrant system will synchronize the file)
• Folder Path → null
• File Path → null
• Base64 Content → "data:<mimetype_of_file>;base64,.... ” (A base64 conversion site can be used to get the content of the file in base64 format. This content must be specified along with the mime type of the file).
• Collection Name (optional) → googledrive1‍
• Correlation Id (optional) → correlationId