Skip to content

Commit

Permalink
Update readme (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
jirispilka authored Jun 18, 2024
1 parent 46b0fed commit 59a5603
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/jirispilka/openai-vector-store-integration/blob/main/LICENSE)
[![Build & Unit Tests](https://github.com/jirispilka/openai-vector-store-integration/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/jirispilka/openai-vector-store-integration/actions/workflows/main.yml)

The Apify OpenAI Vector Store integration allows dynamic updates to the OpenAI Assistant files.
The Apify OpenAI Vector Store integration uploads data from Apify Actors to the OpenAI Vector Store (connected to the OpenAI Assistant).
It assumes that you have already created an [OpenAI Assistant](https://platform.openai.com/docs/assistants/overview/agents) and [OpenAI Vector Store](https://platform.openai.com/docs/assistants/tools/file-search/vector-stores) and you need to regularly update the files to provide up-to-date responses.

💡 **Note**: This Actor is meant to be used together with other Actors' integration sections.
Expand Down Expand Up @@ -47,9 +47,9 @@ Refer to [input schema](.actor/input_schema.json) for details.
- `datasetFields` - Array of datasetFields you want to save, e.g., `["url", "text", "metadata.title"]`.
- `fileIdsToDelete` - Delete specified file IDs from vector store as needed.
- `filePrefix` - Delete and create files using a filePrefix, streamlining vector store updates.
- `datasetId`: [Debug] Dataset ID (when running Actor as standalone without integration).
- `keyValueStoreId`: [Debug] Key Value Store ID (when running Actor as standalone without integration).
- `saveInApifyKeyValueStore`: [Debug] Save all created files in the Apify Key-Value Store to easily check and retrieve all files (this is typically used when debugging)
- `datasetId`: _[Debug]_ Dataset ID (when running Actor as standalone without integration).
- `keyValueStoreId`: _[Debug]_ Key Value Store ID (when running Actor as standalone without integration).
- `saveInApifyKeyValueStore`: _[Debug]_ Save all created files in the Apify Key-Value Store to easily check and retrieve all files (this is typically used when debugging)

## Outputs

Expand Down

0 comments on commit 59a5603

Please sign in to comment.