@inductiv/node-red-openai-api/src/vector-store-files/help.html

Enhance your Node-RED projects with advanced AI capabilities.

<section>
    <details>
        <summary style="font-weight: bold;">📑 Vector Store Files</summary>
        <a href="https://platform.openai.com/docs/api-reference/vector-stores-files" target="_blank">Official
            Documentation
            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>

        <h4 style="font-weight: bolder;"> ⋙ Create Vector Store File</h4>
        <p>Create a vector store file by attaching a File to a vector store.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>
            <dt>
                vector_store_id
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/createFile#vector-stores-files-createfile-vector_store_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the vector store for which to create a File.</dd>

            <dt>
                file_id
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/createFile#vector-stores-files-createfile-file_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>A File ID that the vector store should use. Useful for tools like file_search that can access files.
            </dd>
        </dl>


        <h4 style="font-weight: bolder;"> ⋙ List Vector Store Files</h4>
        <p>Returns a list of vector store files.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>
            <dt>
                vector_store_id
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-vector_store_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the vector store that the files belong to.</dd>

            <dt class="optional">
                limit
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-limit"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">integer</span>
            </dt>
            <dd>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is
                20.</dd>

            <dt class="optional">
                order
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-order"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending
                order.</dd>

            <dt class="optional">
                before
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-before"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>A cursor for use in pagination. before is an object ID that defines your place in the list.</dd>

            <dt class="optional">
                after
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-after"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>A cursor for use in pagination. after is an object ID that defines your place in the list.</dd>

            <dt class="optional">
                filter
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-filter"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>Filter by file status. One of in_progress, completed, failed, cancelled.</dd>

        </dl>

        <h4 style="font-weight: bolder;"> ⋙ Retrieve Vector Store File</h4>
        <p>Retrieves a vector store file.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>
            <dt>
                vector_store_id
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/getFile#vector-stores-files-getfile-vector_store_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the vector store that the file belongs to.</dd>

            <dt>
                file_id
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/getFile#vector-stores-files-getfile-file_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the file being retrieved.</dd>

        </dl>

        <h4 style="font-weight: bolder;"> ⋙ Delete Vector Store File</h4>
        <p>Remove a file from a vector store.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>
            <dt>
                vector_store_id
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/deleteFile#vector-stores-files-deletefile-vector_store_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the vector store that the file belongs to.</dd>

            <dt>
                file_id
                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/deleteFile#vector-stores-files-deletefile-file_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the file to remove from the vector store.</dd>

        </dl>


    </details>
</section>