--- title: "GetHuggingFaceModel" method: GET path: "/v1/namespaces/{tenant_meta.namespace}/hugging-face-models/{uuid}" tags: ["HuggingFaceModelService"] --- # GetHuggingFaceModel `GET /v1/namespaces/{tenant_meta.namespace}/hugging-face-models/{uuid}` ## Request - Base URL: `https://api.endorlabs.com` - URL: `https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/hugging-face-models/{uuid}` - Auth: none declared Fetches the HuggingFace model specified by the UUID. ## Path parameters - `tenant_meta.namespace` string, required - `uuid` string, required ## Query parameters - `get_parameters.mask` string ## Response `200` A successful response. - V1HuggingFaceModel: HuggingFaceModel represents the JSON object from ingesting from the HuggingFace API. - `meta` V1Meta, required: Common fields for all Endor Labs resources. - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string: Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float: search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time: Time that the resource will be deleted. - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required: Resource name. Must be 63 characters or less. - `parent_kind` string: Parent object resource kind, for example, Project. - `parent_uuid` string: Parent object UUID. - `references` object: Map of objects referenced in a query API. - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string: Message version. - `spec` V1HuggingFaceModelSpec, required - `author` string: Author of the model. For example, "openai". - `authorization_required` boolean: Requires authorized request to access the model. - `card_data` object: Model card metadata. - `config` object: Model configuration. - `config_content` string: config.json file content. - `created_at` string, date-time: Date of creation of the repository on the Hub. - `disabled` boolean: Whether the repository is disabled or not. - `discussions` V1Discussion - `count` integer: Total count of discussion posts/pull requests. - `num_closed` integer: Count of closed discussion posts/pull requests. - `downloads` integer: Number of downloads of the model. - `gated` V1Gated - `disabled` boolean - `mode_type` string - `id` string: ID of model (_id). - `last_modified` string, date-time: Date of last commit to the repository. - `library_name` string: Library associated with the model. - `likes` integer: Number of likes of the model. - `mask_token` string: Mask token used by the model. - `model_id` string: Author and model name (seems to hold the same value as the name field). - `model_index` object[]: Model index for evaluation. - `name` string: Author and model name (id). For example, "openai/clip-vit-base-patch16". - `organization_name` string: Organization name for which this model belongs to. - `pipeline_tag` string: Pipeline tag associated with the model. - `private` boolean: Whether the repository is private not. - `project_uuid` string, required: The UUID of the project that this model relates to. - `pull_requests` V1Discussion - `count` integer: Total count of discussion posts/pull requests. - `num_closed` integer: Count of closed discussion posts/pull requests. - `readme_content` string: README.md file content. - `readme_metadata` V1ReadmeMetadata - `alignment_trained` V1ReadmeAIQuery - `answer` string[]: Extracted string answer from the raw response. - `evidence` string: Extracted evidence supporting answer from the raw response. - `exists` boolean: Extracted boolean whether or not specified field in prompt exists. - `prompt` string: Prompt to query AI. - `raw_response` string: Raw response received from the query. - `base_model` V1ReadmeAIQuery - `answer` string[]: Extracted string answer from the raw response. - `evidence` string: Extracted evidence supporting answer from the raw response. - `exists` boolean: Extracted boolean whether or not specified field in prompt exists. - `prompt` string: Prompt to query AI. - `raw_response` string: Raw response received from the query. - `evaluation_results` V1ReadmeAIQuery - `answer` string[]: Extracted string answer from the raw response. - `evidence` string: Extracted evidence supporting answer from the raw response. - `exists` boolean: Extracted boolean whether or not specified field in prompt exists. - `prompt` string: Prompt to query AI. - `raw_response` string: Raw response received from the query. - `example_code` V1ReadmeAIQuery - `answer` string[]: Extracted string answer from the raw response. - `evidence` string: Extracted evidence supporting answer from the raw response. - `exists` boolean: Extracted boolean whether or not specified field in prompt exists. - `prompt` string: Prompt to query AI. - `raw_response` string: Raw response received from the query. - `fine_tuned` V1ReadmeAIQuery - `answer` string[]: Extracted string answer from the raw response. - `evidence` string: Extracted evidence supporting answer from the raw response. - `exists` boolean: Extracted boolean whether or not specified field in prompt exists. - `prompt` string: Prompt to query AI. - `raw_response` string: Raw response received from the query. - `linked_github` V1ReadmeAIQuery - `answer` string[]: Extracted string answer from the raw response. - `evidence` string: Extracted evidence supporting answer from the raw response. - `exists` boolean: Extracted boolean whether or not specified field in prompt exists. - `prompt` string: Prompt to query AI. - `raw_response` string: Raw response received from the query. - `training_data` V1ReadmeAIQuery - `answer` string[]: Extracted string answer from the raw response. - `evidence` string: Extracted evidence supporting answer from the raw response. - `exists` boolean: Extracted boolean whether or not specified field in prompt exists. - `prompt` string: Prompt to query AI. - `raw_response` string: Raw response received from the query. - `safetensors` object: Model's safetensors information. - `sha` string: Repository SHA at this particular revision. - `siblings` V1Sibling[]: List of files that constitute the model. - `rfilename` string: The filename within a specific model. - `spaces` string[]: List of spaces using the model. - `tags` string[]: List of tags of the model. - `transformers_info` object: Transformers-specific information associated with the model. - `widget_data` object[]: Widget data associated with the model. - `tenant_meta` V1TenantMeta: Tenant related data for the tenant containing the resource. - `namespace` string, required: Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". - `uuid` string: The UUID for the ingested HuggingFace model. ## Other responses - `default`: An unexpected error response. --- [API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) - [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/revisions/4acd9fe15140?raw)