Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.99 KB

File metadata and controls

40 lines (31 loc) · 1.99 KB

InstantiatedScaffoldResponse

Response after successful scaffold instantiation. Contains IDs and names of all four created resources. Use these IDs for subsequent operations: - Upload data: POST /v1/buckets/{bucket_id}/objects - Process: POST /v1/collections/{collection_id}/batches - Search: POST /v1/retrievers/{retriever_id}/retrieve

Properties

Name Type Description Notes
namespace_id str Created namespace ID (ns_xxx)
namespace_name str Created namespace name
bucket_id str Created bucket ID (bkt_xxx)
bucket_name str Created bucket name
collection_id str Created collection ID (col_xxx)
collection_name str Created collection name
retriever_id str Created retriever ID (ret_xxx)
retriever_name str Created retriever name
template_id str Scaffold template ID used
status str Status: 'created' on success [optional] [default to 'created']
created_at datetime UTC timestamp of creation [optional]

Example

from mixpeek.models.instantiated_scaffold_response import InstantiatedScaffoldResponse

# TODO update the JSON string below
json = "{}"
# create an instance of InstantiatedScaffoldResponse from a JSON string
instantiated_scaffold_response_instance = InstantiatedScaffoldResponse.from_json(json)
# print the JSON string representation of the object
print(InstantiatedScaffoldResponse.to_json())

# convert the object into a dict
instantiated_scaffold_response_dict = instantiated_scaffold_response_instance.to_dict()
# create an instance of InstantiatedScaffoldResponse from a dict
instantiated_scaffold_response_from_dict = InstantiatedScaffoldResponse.from_dict(instantiated_scaffold_response_dict)

[Back to Model list] [Back to API list] [Back to README]