https://github.com/vectara/vectara-index-git-docs

Index contents from a GitHub repository to Vectara
https://github.com/vectara/vectara-index-git-docs

search vectara

Last synced: 11 days ago
JSON representation

Index contents from a GitHub repository to Vectara

• Host: GitHub
• URL: https://github.com/vectara/vectara-index-git-docs
• Owner: vectara
• License: apache-2.0
• Created: 2022-09-27T18:03:12.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-04T18:14:42.000Z (almost 2 years ago)
• Last Synced: 2024-03-15T07:03:15.514Z (9 months ago)
• Topics: search, vectara
• Language: Shell
• Homepage:
• Size: 31.3 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## vectara-index-git-docs

Find all documents that have changed in a GitHub repository and submit them to Vectara.

Useful for auto-indexing documentation and other enterprise content contained in GitHub repositories.

## Usage

To use this GitHub action, add a file at `.github/workflows/vectara.yml` with the following contents.

Add secrets to the repository for the `secrets.` values in this template.

```yaml

name: CI

on:

  push:

    branches:

      - main

  pull_request:

    branches:

      - main

jobs:

  build:

    runs-on: ubuntu-latest

    name: Index changed-files

    steps:

      - uses: vectara/[email protected]

        with:

          vectaraAccountNumber: ${{ secrets.VECTARA_ACCOUNT_NUMBER }}

          vectaraCorpusID: ${{ secrets.VECTARA_CORPUS_NUMBER }}

          vectaraClientID: ${{ secrets.VECTARA_CLIENT_ID }}

          vectaraClientSecret: ${{ secrets.VECTARA_CLIENT_SECRET }}

          filesPattern: |

            **/*.md

```

## Configuration

|      Parameter          |   Description                                | Default

|:-----------------------:|:--------------------------------------------:|:----------------------------:

|   vectaraAccountNumber  | Vectara Account Number                       | N/A

|      vectaraCorpusID    | Vectara Account ID                           | N/A

|      vectaraClientID    | Vectara OAuth2 Client ID                     | N/A

|    vectaraClientSecret  | Vectara OAuth2 Client Secret                 | N/A

|   incrementalIndexing   | Whether this is the first time indexing (set to "true") to you want an incremental | true

|       filesPattern      | What files to index                          | Optional: ** (All files)

|   vectaraAuthEndpoint   | Where to authenticate for an OAuth 2.0 token | Optional: Auto-set based on your Account number

| vectaraIndexingEndpoint | api.vectara.io                               | Optional: not needed for most accounts