UncountablePythonSDK 0.0.7__py3-none-any.whl → 0.0.92__py3-none-any.whl

type_spec/external/api/project/get_projects_data.yaml

@@ -1,86 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/project/external_get_projects_data
-    function: main.site.app.external.project.get_projects_data.get_projects_data
-    desc: "Gets either all data associated with a set of projects created in the platform.  Because Uncountables recipe structure is complex, various data values are exploded out to increase efficiency in parsing, and this page is paginated to prevent too large of return values"
-Arguments:
-    type: Object
-    properties:
-        project_ids:
-            type: List<Integer>
-            desc: "The projects to get the data from"
-        offset:
-            type: Optional<Integer>
-            desc: "Used for pagination. All pagination is done in order of Project ID"
-        limit:
-            type: Optional<Integer>
-            desc: "The number of data points to return. If not filled in, it will be set to 100, and cannot be set higher than 100"
-
-Field:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the field"
-        name:
-            type: String
-            desc: "The name of the field"
-        value_type:
-            type: String
-            desc: "The type of the field for instance whether it is numeric, text, categorical"
-
-FieldValue:
-    type: Object
-    properties:
-        field_id:
-            type: Integer
-            desc: "The unique ID for the field"
-        row_index:
-            type: Optional<Integer>
-            desc: "For table fields, which row of the table is the value on"
-        value:
-            type: JsonValue
-            desc: "The value for the field"
-
-ProjectDetailed:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the project. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the project"
-        material_family_id:
-            type: Integer
-            desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
-        project_owner_id:
-            type: Optional<Integer>
-            desc: "The projects owner, as a user ID within the platform"
-        phase_id:
-            type: Optional<Integer>
-            desc: "The phase id corresponding to a phase workflow"
-        values:
-            type: List<FieldValue>
-            desc: "List of fields and values associated with the project"
-
-Phase:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the phase. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the phase"
-
-Data:
-    type: Object
-    properties:
-        projects:
-            type: List<ProjectDetailed>
-        phases:
-            type: List<Phase>
-        fields:
-            type: List<Field>

type_spec/external/api/recipe_metadata/get_recipe_metadata_data.yaml

@@ -1,41 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipe_metadata/external_get_recipe_metadata_data
-    function: main.site.app.external.recipe_metadata.get_recipe_metadata_data.get_recipe_metadata_data
-    desc: "Gets the recipe metadata. Recipe metadata is data associated with experiments that is not an input, output or calculation, such as a sample ID."
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: Integer
-            desc: "The material family ID to get the recipe metadata values from."
-        recipe_metadata_ids:
-            type: Optional<List<Integer>>
-            desc: "The recipe metadata IDs to get the data from. If this is not filled in, all metadata from a material family will be returned (in paginated form)."
-        offset:
-            type: Optional<Integer>
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the metadata ID"
-        limit:
-            type: Optional<Integer>
-            desc: "The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000"
-
-FullRecipeMetadataField:
-    type: Object
-    properties:
-        recipe_metadata_id:
-            type: Integer
-            desc: "The unique integer ID of the recipe metadata value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the recipe metadata"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the recipe metadata, such as numeric, categorical or text"
-
-Data:
-    type: Object
-    properties:
-        recipe_metadata:
-            type: List<FullRecipeMetadataField>

type_spec/external/api/recipes/create_recipes.yaml

@@ -1,60 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/recipes/external_create_recipes
-    function: main.site.app.external.recipes.create_recipes.create_recipes
-    desc: "Sets inputs values for an experiment. Values set can be numeric, text or categorical types in the Uncountable system"
-
-MetadataValue:
-    type: Object
-    properties:
-        metadata_id:
-            type: Integer
-            desc: The id of the metadata field to populate
-        value_numeric?:
-            type: Decimal
-            desc: "The numeric value for the metadata. Should be none if output is not of type numeric."
-        value_str?:
-            type: String
-            desc: "The string value for the metadata if applicable for this metadata field"
-
-CreateRecipeDefinition:
-    type: Object
-    properties:
-        name?:
-            type: String
-            desc: "The name for the recipe"
-        workflow_id:
-            type: Integer
-            desc: "The identifier of the workflow to create the recipe with"
-        workflow_variant_id?:
-            type: Optional<ObjectId>
-            desc: "The identifier of the workflow variant to create the recipe with"
-        recipe_metadata?:
-            type: List<MetadataValue>
-            desc: "Metadata values to populate the recipe with"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: Integer
-            desc: "The identifier of the material family to create the recipes in"
-        project_id?:
-            type: Integer
-            desc: "The identifier of the project to create the recipes in"
-        recipe_definitions:
-            type: List<CreateRecipeDefinition>
-
-CreateRecipeResult:
-    type: Object
-    properties:
-        recipe_id:
-            type: Integer
-            desc: The identifier for the created recipe
-
-Data:
-    type: Object
-    properties:
-        recipes:
-            type: List<CreateRecipeResult>

type_spec/external/api/recipes/get_curve.yaml

@@ -1,50 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_curve
-    function: main.site.app.external.recipes.get_curve.get_curve
-    desc: "Returns an array of values for the specified curve id."
-Arguments:
-    type: Object
-    properties:
-        recipe_output_id:
-            type: Integer
-            desc: "The recipe output ID to fetch the curve for. This must be a curve recipe output. Recipe Outputs can be found from external_get_recipes_data"
-
-CurveValue:
-    type: Object
-    properties:
-        index:
-            type: Integer
-            desc: "The index of the value in the curve"
-        quantity?:
-            type: Decimal
-            desc: "The value for the curve if the curve is a numeric curve"
-        quantity_timestamp?:
-            type: DateTime
-            desc: "The timestamp value if the curve is a timestamp curve in UTC"
-
-Curve:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "The unique integer ID of the curve. Used for joining and identification elsewhere"
-        x_type:
-            type: String
-            desc: "The type of axis for the x-axis.  Options include numeric and timestamp"
-        x_values:
-            type: List<CurveValue>
-            desc: "The values for the x-axis"
-        y_type:
-            type: String
-            desc: "The type of axis for the y-axis.  Options include numeric"
-        y_values:
-            type: List<CurveValue>
-            desc: "The values for the y-axis"
-
-Data:
-    type: Object
-    properties:
-        curve:
-            type: Curve

type_spec/external/api/recipes/get_recipe_calculations.yaml

@@ -1,49 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_calculations
-    function: main.site.app.external.recipes.get_recipe_calculations.get_recipe_calculations
-    desc: "Gets the calculations for the passed recipes"
-Arguments:
-    type: Object
-    properties:
-        recipe_ids:
-            type: List<Integer>
-            desc: "Ids of the Recipes to retrieve calculations for"
-        calculation_ids?:
-            type: List<Integer>
-            desc: "Optionally a list of ids of calculations to retrieve"
-
-RecipeCalculation:
-    type: Object
-    properties:
-        recipe_id:
-            type: Integer
-            desc: "Identifier for the recipe"
-        calculation_id:
-            type: Integer
-            desc: "Identifier for the calculation"
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the calculation, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the calculation, if it is not of numeric type"
-
-Calculation:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "Identifier for the calculation"
-        name:
-            type: String
-            desc: "Name of the calculation"
-
-Data:
-    type: Object
-    properties:
-        recipe_calculations:
-            type: List<RecipeCalculation>
-        calculations:
-            type: List<Calculation>

type_spec/external/api/recipes/get_recipe_links.yaml

@@ -1,26 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_links
-    function: main.site.app.external.recipes.get_recipe_links.get_recipe_links
-    desc: "Gets the links for the passed recipes"
-
-Arguments:
-    type: Object
-    properties:
-        recipe_ids:
-            type: List<Integer>
-            desc: "Ids of the Recipes to retrieve links for"
-        depth:
-            type: Integer
-            desc: "How many layers deep to look for links"
-            default: 1
-        link_types:
-            type: Optional<List<recipe_links.RecipeLinkType>>
-            desc: "Optional filter to only desired link types"
-
-Data:
-    type: Object
-    properties:
-        recipe_links:
-            type: List<recipe_links.RecipeLink>

type_spec/external/api/recipes/get_recipe_names.yaml

@@ -1,29 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_names
-    function: main.site.app.external.recipes.get_recipe_names.get_recipe_names
-    desc: "Gets the name of all recipes (or experiments, used as synonyms by Uncountable) for a project. The call external_get_projects can be used to find projects"
-
-Arguments:
-    type: Object
-    properties:
-        project_id:
-            type: Integer
-            desc: "Required: The project ID to get the recipes/experiments from."
-
-SimpleRecipe:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "The unique integer ID of the recipe/experiment. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the recipe"
-
-Data:
-    type: Object
-    properties:
-        recipes:
-            type: List<SimpleRecipe>

type_spec/external/api/recipes/get_recipe_output_metadata.yaml

@@ -1,49 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_output_metadata
-    function: main.site.app.external.recipes.get_recipe_output_metadata.get_recipe_output_metadata
-    desc: "Gets the metadata values for the passed recipe outputs"
-Arguments:
-    type: Object
-    properties:
-        recipe_output_ids:
-            type: List<Integer>
-            desc: "Ids of the Recipe Outputs to retrieve metadata for"
-
-RecipeOutputMetadata:
-    type: Object
-    properties:
-        recipe_output_id:
-            type: Integer
-            desc: "Identifier for the recipe output"
-        recipe_output_metadata_field_id:
-            type: Integer
-            desc: "Identifier for the metadata field id"
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the metadata, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the metadata, if it is not of numeric type"
-
-RecipeOutputMetadataField:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "Identifier for the recipe output metadata field"
-        name:
-            type: String
-            desc: "Name of the recipe output metadata field"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the metadata, such as numeric or text"
-
-Data:
-    type: Object
-    properties:
-        recipe_output_metadata:
-            type: List<RecipeOutputMetadata>
-        recipe_output_metadata_fields:
-            type: List<RecipeOutputMetadataField>