Sharing Use Cases

Use Case 1: Private Documents

Allows users to keep their uploaded documents private, ensuring that they are not shared with anyone else at your organization on the AlphaSense platform. This functionality is crucial for maintaining confidentiality and privacy of sensitive information.

Implementation Steps

Via AlphaSense UI

1. Log in, click your profile icon and navigate to Preferences > Sharing & Privacy.
2. Ensure both options are turned off. ↗

Via Ingestion API

1. Adjust the IngestionAPIShareInfo model to NONE. This setting restricts the visibility of the documents to only the uploader.
2. (Optional) Use the CustomTag model to set the visibility of tags associated with the documents to PRIVATE. This adds an additional layer of privacy to your document metadata.

Command to modify document visibility to NONE

curl --location --request PATCH "https://research.alphasense.com/services/i/ingestion-api/v2/bulk/modify/metadata" \
--header "Authorization: Bearer <your_access_token>" \
--header "clientId: <your_client_id>" \
--header "Content-Type: application/json" \
--header "accept: application/json" \
--data-raw '{
    "docIds": ["<doc_id_1>", "<doc_id_2>", "..."],
    "shareInfo": {
        "mode": "NONE"
    },
    "documentOwner": "<username>"
}'

Use Case 2: Universal Accessibility

Enables users at your organization within AlphaSense to search and access any document, fostering an environment of open information sharing.

Implementation Steps

Via AlphaSense UI

1. Log in, click your profile icon and navigate to Preferences > Sharing & Privacy.
2. Enable Documents You Add to AlphaSense Are Visible By Default to on
3. Set Make documents visible to to Everyone in your firm. ↗.

Via Ingestion API

1. Adjust the IngestionAPIShareInfo model to EVERYONE. This setting allows every user from your organization on the platform to search for and access any document.
2. (Optional) Use the CustomTag model to set the visibility of tags associated with the documents to PUBLIC.

Command to modify document visibility to EVERYONE

curl --location --request PATCH "https://research.alphasense.com/services/i/ingestion-api/v2/bulk/modify/metadata" \
--header "Authorization: Bearer <your_access_token>" \
--header "clientId: <your_client_id>" \
--header "Content-Type: application/json" \
--header "accept: application/json" \
--data-raw '{
    "docIds": ["<doc_id_1>", "<doc_id_2>", "..."],
    "shareInfo": {
        "mode": "EVERYONE"
    },
    "documentOwner": "<username>"
}'

Use Case 3: Explicit Permissions

Enable document sharing with a specific set of users and/or groups, allowing for controlled access and collaboration.

Implementation Steps

Via AlphaSense UI

1. Log in, click your profile icon and navigate to Preferences > Sharing & Privacy. ↗
2. Click select and choose the specific groups and/or users from a list who are allowed to search and access the documents. ↗
3. Use the AlphaSense UI to create groups and add users as needed. ↗

Via Ingestion API

1. Use the AlphaSense UI to create groups and add users as needed (See steps 1 and 3 above)
2. Utilize the Ingestion API with the IngestionAPIShareInfo mode set to DEFAULT for the created groups and users.

Command to modify document visibility to DEFAULT

curl --location --request PATCH "https://research.alphasense.com/services/i/ingestion-api/v2/bulk/modify/metadata" \
--header "Authorization: Bearer <your_access_token>" \
--header "clientId: <your_client_id>" \
--header "Content-Type: application/json" \
--header "accept: application/json" \
--data-raw '{
    "docIds": ["<doc_id_1>", "<doc_id_2>", "..."],
    "shareInfo": {
        "mode": "DEFAULT"
    },
    "documentOwner": "<username>"
}'

Use Case 4: Custom Sharing

For more complex sharing requirements, AlphaSense offers a CUSTOM sharing mode, allowing granular control over document permissions.

Implementation Steps

Via Ingestion API

info

Custom sharing is only available for Enterprise customers that have implemented the SCIM API.

This API enables customers to generate and retrieve external IDs for their users or groups. Leveraging these IDs ensures that documents are shared correctly and securely, according to the client's specific requirements.

1. Utilize the SCIM API to retrieve the externalID for the users or groups that you want to share the documents with.
2. Utilize the Ingestion API with the IngestionAPIShareInfo mode set to CUSTOM and include the externalIDs you want to share the documents with.

Command to modify document visibility to CUSTOM

curl --location --request PATCH "https://research.alphasense.com/services/i/ingestion-api/v2/bulk/modify/metadata" \
--header "Authorization: Bearer <your_access_token>" \
--header "clientId: <your_client_id>" \
--header "Content-Type: application/json" \
--header "accept: application/json" \
--data-raw '{
    "docIds": ["<doc_id_1>", "<doc_id_2>", "..."],
    "shareInfo": {
        "mode": "CUSTOM",
        "externalIds": ["<external_id_1>", "<external_id_2>", "..."]
    },
    "documentOwner": "<username>"
}'

Use Case 5: Restricted Sharing Groups

Restricts document sharing and collaboration within specific business units, suitable for large organizations with multiple internal divisions.

warning

In the event of user movement between units, document ownership and collaborative elements will remain within the original unit.

To enable this sharing model, please contact your Account Manager for assistance.