nv_ingest_api.internal.schemas.store package#

Submodules#

nv_ingest_api.internal.schemas.store.store_embedding_schema module#

pydantic model nv_ingest_api.internal.schemas.store.store_embedding_schema.EmbeddingStorageSchema[source]#

Bases: BaseModel

Show JSON schema
{
   "title": "EmbeddingStorageSchema",
   "type": "object",
   "properties": {
      "raise_on_failure": {
         "default": false,
         "title": "Raise On Failure",
         "type": "boolean"
      }
   },
   "additionalProperties": false
}

Config:

  • extra: str = forbid

Fields:
field raise_on_failure: bool = False#

nv_ingest_api.internal.schemas.store.store_image_schema module#

pydantic model nv_ingest_api.internal.schemas.store.store_image_schema.ImageStorageModuleSchema[source]#

Bases: BaseModel

Show JSON schema
{
   "title": "ImageStorageModuleSchema",
   "type": "object",
   "properties": {
      "structured": {
         "default": true,
         "title": "Structured",
         "type": "boolean"
      },
      "images": {
         "default": true,
         "title": "Images",
         "type": "boolean"
      },
      "storage_uri": {
         "title": "Storage Uri",
         "type": "string"
      },
      "storage_options": {
         "additionalProperties": true,
         "title": "Storage Options",
         "type": "object"
      },
      "public_base_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Public Base Url"
      },
      "raise_on_failure": {
         "default": false,
         "title": "Raise On Failure",
         "type": "boolean"
      }
   },
   "additionalProperties": false
}

Config:

  • extra: str = forbid

Fields:
Validators:
field images: bool = True#
field public_base_url: str | None = None#
field raise_on_failure: bool = False#
field storage_options: Dict[str, Any] [Optional]#
field storage_uri: str [Optional]#
Validated by:
field structured: bool = True#
validator validate_storage_uri  »  storage_uri[source]#

Module contents#