@grepvine/sdk
    Preparing search index...

    Type Alias PutDocumentData

    type PutDocumentData = {
        body: { content: Blob | File; key: string; metadata?: string };
        headers?: {
            "Idempotency-Key"?: string;
            "If-Match"?: string;
            "If-None-Match"?: "*";
        };
        path: { index: IndexName; organization: Name };
        query?: never;
        url: "/organizations/{organization}/indexes/{index}/objects";
    }
    Index
    body headers? path query? url

    body

    body: { content: Blob | File; key: string; metadata?: string }

    Type Declaration

    • content: Blob | File

      The document bytes, at most 1 GiB. Valid UTF-8 of at most 100 MiB is searchable; other content is stored without being searchable.

    • key: string
    • Optionalmetadata?: string

      A Metadata JSON object.

    headers?: {
        "Idempotency-Key"?: string;
        "If-Match"?: string;
        "If-None-Match"?: "*";
    }
    path: { index: IndexName; organization: Name }
    query?: never
    url: "/organizations/{organization}/indexes/{index}/objects"

    Settings
    Member Visibility

    On This Page
    Properties