sift_py.file_attachment
This module contains services to facilitate uploading and downloading file attachments. It also provides utilities to easily query all file attachments for a given entity which could be a run, annotation, or annotation logs. File attachment deletion is also supported.
Once files have been attached, they should be viewable on the Sift application, attached to their
respective entities. Below are various examples on how to leverage the sift_py.file_attachment.service.FileAttachmentService.
Initializing the file attachment service
Unlike other services throughout sift_py, the sift_py.file_attachment.service.FileAttachmentService does rely on both
REST and gRPC APIs, so with that in mind we can initialize our service like so:
from sift_py.grpc.transport import SiftChannelConfig, use_sift_channel
from sift_py.file_attachment.service import FileAttachmentService
from sift_py.file_attachment.entity import Entity, EntityType
from sift_py.file_attachment.metadata import ImageMetadata
from sift_py.rest import SiftRestConfig
from sift.remote_files.v1.remote_files_pb2 import GetRemoteFileRequest
from sift.remote_files.v1.remote_files_pb2_grpc import RemoteFileServiceStub
rest_config: SiftRestConfig = {
# Be sure to exclude the "https://" or "http://" scheme out of the uri
"uri": rest_base_uri,
"apikey": apikey,
}
sift_channel_config = SiftChannelConfig(uri=grpc_base_uri, apikey=apikey)
with use_sift_channel(sift_channel_config) as channel:
file_attachment_service = FileAttachmentService(channel, rest_config)
...
With the service initialized we can now interact with the file attachments API.
Various Examples
For demonstrative purposes we will upload an mp4 file and attach to a run of run_id.
Once it is uploaded we will query all file attachments for a particular run and re-download
what we just uploaded.
from sift_py.grpc.transport import SiftChannelConfig, use_sift_channel
from sift_py.file_attachment.service import FileAttachmentService
from sift_py.file_attachment.entity import Entity, EntityType
from sift_py.file_attachment.metadata import VideoMetadata
from sift_py.rest import SiftRestConfig
from sift.remote_files.v1.remote_files_pb2 import GetRemoteFileRequest
from sift.remote_files.v1.remote_files_pb2_grpc import RemoteFileServiceStub
...
with use_sift_channel(sift_channel_config) as channel:
file_attachment_service = FileAttachmentService(channel, rest_config)
run = entity=Entity(
entity_id=run_id, # some arbitrary run ID that refers to an existing run
entity_type=EntityType.RUN,
)
# uploading the file attachment and attaching it to a run of `run_id`.
remote_file = file_attachment_service.upload_attachment(
path="path/to/foo.mp4",
entity=run,
# Metatadata.. optional but recommended for optimal viewing in the application
metadata=VideoMetadata(height=2160, width=3840, duration_seconds=5.5, timestamp=datetime(2024, 10, 19, 2, 22, 22),
description="thrusters getting too hot" ,
)
# retrieving all of the file attachments for our run
all_file_attachments = file_attachment_service.retrieve_attachments(run)
# downloading our file_attachment and saving it to our current working dir
file_attachment_service.download_attachment(remote_file)
# downloading our file_attachment and saving it somewhere else with a different name
file_attachment_service.download_attachment(remote_file, "somewhere/else/foo.mp4")
# deleting out file attachment from Sift
file_attachment_service.delete_file_attachments(remote_file_1, remote_file_2, remote_file_etc)
1""" 2This module contains services to facilitate uploading and downloading file attachments. 3It also provides utilities to easily query all file attachments for a given entity 4which could be a run, annotation, or annotation logs. File attachment deletion is also supported. 5 6Once files have been attached, they should be viewable on the Sift application, attached to their 7respective entities. Below are various examples on how to leverage the `sift_py.file_attachment.service.FileAttachmentService`. 8 9## Initializing the file attachment service 10 11Unlike other services throughout `sift_py`, the `sift_py.file_attachment.service.FileAttachmentService` does rely on both 12REST and gRPC APIs, so with that in mind we can initialize our service like so: 13 14```python 15from sift_py.grpc.transport import SiftChannelConfig, use_sift_channel 16from sift_py.file_attachment.service import FileAttachmentService 17from sift_py.file_attachment.entity import Entity, EntityType 18from sift_py.file_attachment.metadata import ImageMetadata 19from sift_py.rest import SiftRestConfig 20 21from sift.remote_files.v1.remote_files_pb2 import GetRemoteFileRequest 22from sift.remote_files.v1.remote_files_pb2_grpc import RemoteFileServiceStub 23 24rest_config: SiftRestConfig = { 25 # Be sure to exclude the "https://" or "http://" scheme out of the uri 26 "uri": rest_base_uri, 27 "apikey": apikey, 28} 29 30sift_channel_config = SiftChannelConfig(uri=grpc_base_uri, apikey=apikey) 31 32with use_sift_channel(sift_channel_config) as channel: 33 file_attachment_service = FileAttachmentService(channel, rest_config) 34 ... 35``` 36 37With the service initialized we can now interact with the file attachments API. 38 39## Various Examples 40 41For demonstrative purposes we will upload an `mp4` file and attach to a run of `run_id`. 42Once it is uploaded we will query all file attachments for a particular run and re-download 43what we just uploaded. 44 45```python 46 47from sift_py.grpc.transport import SiftChannelConfig, use_sift_channel 48from sift_py.file_attachment.service import FileAttachmentService 49from sift_py.file_attachment.entity import Entity, EntityType 50from sift_py.file_attachment.metadata import VideoMetadata 51from sift_py.rest import SiftRestConfig 52 53from sift.remote_files.v1.remote_files_pb2 import GetRemoteFileRequest 54from sift.remote_files.v1.remote_files_pb2_grpc import RemoteFileServiceStub 55 56... 57 58with use_sift_channel(sift_channel_config) as channel: 59 file_attachment_service = FileAttachmentService(channel, rest_config) 60 61 run = entity=Entity( 62 entity_id=run_id, # some arbitrary run ID that refers to an existing run 63 entity_type=EntityType.RUN, 64 ) 65 66 # uploading the file attachment and attaching it to a run of `run_id`. 67 remote_file = file_attachment_service.upload_attachment( 68 path="path/to/foo.mp4", 69 entity=run, 70 # Metatadata.. optional but recommended for optimal viewing in the application 71 metadata=VideoMetadata(height=2160, width=3840, duration_seconds=5.5, timestamp=datetime(2024, 10, 19, 2, 22, 22), 72 description="thrusters getting too hot" , 73 ) 74 75 # retrieving all of the file attachments for our run 76 all_file_attachments = file_attachment_service.retrieve_attachments(run) 77 78 # downloading our file_attachment and saving it to our current working dir 79 file_attachment_service.download_attachment(remote_file) 80 81 # downloading our file_attachment and saving it somewhere else with a different name 82 file_attachment_service.download_attachment(remote_file, "somewhere/else/foo.mp4") 83 84 # deleting out file attachment from Sift 85 file_attachment_service.delete_file_attachments(remote_file_1, remote_file_2, remote_file_etc) 86``` 87 88"""