avis-client

VUE Autonomous Visual Inspection System (AVIS)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.8.0
• Package version: 0.8.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/vuengineering/public.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/vuengineering/public.git)

Then import the package:

import avis_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import avis_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import avis_client
from avis_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
    host = "http://localhost:8000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = avis_client.ApiKeysApi(api_client)
    user_api_key_create_request = avis_client.UserAPIKeyCreateRequest() # UserAPIKeyCreateRequest |  (optional)

    try:
        api_response = api_instance.keys_create(user_api_key_create_request=user_api_key_create_request)
        print("The response of ApiKeysApi->keys_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiKeysApi->keys_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Documentation For Models

• AzureMLInferenceRequest
• BlankEnum
• ConfigurationStatistics
• ConfigurationStatisticsRequest
• ConfigurationType
• ConfigurationTypeRequest
• CustomUser
• CustomUserRequest
• EmailAddress
• FormatEnum
• Image
• ImageAttribute
• ImageAttributeCategory
• ImageAttributeCategoryRequest
• ImageAttributeRequest
• ImageRequest
• Inspection
• InspectionImagesStatistics
• InspectionImagesStatisticsRequest
• InspectionRequest
• InspectionStatistics
• InspectionStatisticsRequest
• InspectionValidationStatus
• MLModel
• MLModelRequest
• MLModelType
• MLModelTypeRequest
• Membership
• MembershipRequest
• Metadata
• MetadataRequest
• MetadataSchema
• MetadataSchemaRequest
• PaginatedConfigurationStatisticsList
• PaginatedConfigurationTypeList
• PaginatedImageAttributeCategoryList
• PaginatedImageAttributeList
• PaginatedImageList
• PaginatedInspectionImagesStatisticsList
• PaginatedInspectionList
• PaginatedInspectionStatisticsList
• PaginatedInspectionValidationStatusList
• PaginatedMLModelList
• PaginatedMLModelTypeList
• PaginatedMembershipList
• PaginatedMetadataList
• PaginatedMetadataSchemaList
• PaginatedProductCategoryList
• PaginatedProductList
• PaginatedQualityCriteriaList
• PaginatedQualityCriteriaResultList
• PaginatedResultList
• PaginatedTeamList
• PatchedConfigurationTypeRequest
• PatchedImageAttributeCategoryRequest
• PatchedImageAttributeRequest
• PatchedImageRequest
• PatchedInspectionRequest
• PatchedMLModelRequest
• PatchedMLModelTypeRequest
• PatchedMetadataRequest
• PatchedMetadataSchemaRequest
• PatchedProductCategoryRequest
• PatchedProductRequest
• PatchedQualityCriteriaRequest
• PatchedResultRequest
• PatchedResultRequestStatus
• Product
• ProductCategory
• ProductCategoryRequest
• ProductRequest
• QualityCriteria
• QualityCriteriaRequest
• QualityCriteriaResult
• QualityEnum
• Result
• ResultRequest
• StatusEnum
• Team
• TeamRequest
• UserAPIKeyCreate
• UserAPIKeyCreateRequest
• ValidationStatusEnum

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Api-Key
• Location: HTTP header

cookieAuth

• Type: API key
• API key parameter name: sessionid
• Location:

Author