Skip to content

AI Document: Project

Manage OCI AI Document projects. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot

Field Value
Service aidocument
Resource Project
API Version aidocument.oracle.com/v1beta1
Package AI Document
Support Status Preview
Latest Released Version v2.1.0-alpha
Install Namespace oci-service-operator-aidocument-system

Spec Fields

This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
compartmentId The compartment identifier. string Yes
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No
description An optional description of the project. string No
displayName A human-friendly name for the project, that can be changed. string No
freeformTags A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No

Status Fields

This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
compartmentId The compartment identifier. string No
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No
description An optional description of the project. string No
displayName A human-friendly name for the project, which can be changed. string No
freeformTags A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"} map[string, string] No
id A unique identifier that is immutable after creation. string No
lifecycleDetails A message describing the current state in more detail, that can provide actionable information if creation failed. string No
lifecycleState The current state of the project. string No
locks Locks associated with this resource. list[object] No
status - object Yes
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No
timeCreated When the project was created, as an RFC3339 datetime string. string No
timeUpdated When the project was updated, as an RFC3339 datetime string. string No

Sample Manifest

This example is generated from the checked-in sample manifest at config/samples/aidocument_v1beta1_project.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#

apiVersion: aidocument.oracle.com/v1beta1
kind: Project
metadata:
  name: project-sample
spec: {}