Returns a HTTP/REST client based on an DESTINATION.
+ "! + "! @parameter I_REQUEST_PROP | Request parameters + "! @parameter E_CLIENT | HTTP/REST client + "! @raising ZCX_IBMX_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + CLASS-METHODS create_client_by_destination + IMPORTING + !i_request_prop TYPE ts_request_prop + EXPORTING + !e_client TYPE ts_client + RAISING + ZCX_IBMX_service_exception . "!Returns the default proxy host and port.
"! "! @parameter I_URL | target URL @@ -298,7 +311,32 @@ CLASS ZCL_IBMX_SERVICE_ARCH IMPLEMENTATION. TRY. "create http destination by url DATA(lo_http_destination) = - cl_http_destination_provider=>create_by_url( i_url ). + cl_http_destination_provider=>create_by_url( i_url ). + CATCH cx_http_dest_provider_error. + ENDTRY. + + "create HTTP client by destination + TRY. + e_client-http = cl_web_http_client_manager=>create_by_http_destination( lo_http_destination ) . + CATCH cx_web_http_client_error. + lv_text = `HTTP client cannot be created: ` && lv_text ##NO_TEXT. + ZCL_IBMX_SERVICE=>raise_exception( i_text = lv_text ). + ENDTRY. + + e_client-request = e_client-http->get_http_request( ). + + ENDMETHOD. + + + METHOD create_client_by_destination. + + DATA: + lv_text TYPE string. + + TRY. + "get http destination + DATA(lo_http_destination) = + cl_http_destination_provider=>create_by_destination( i_request_prop-destination ). CATCH cx_http_dest_provider_error. ENDTRY. diff --git a/src/zcl_ibmx_service_arch.clas.xml b/src/zcl_ibmx_service_arch.clas.xml index 2abcc3c..c2507fb 100644 --- a/src/zcl_ibmx_service_arch.clas.xml +++ b/src/zcl_ibmx_service_arch.clas.xml @@ -36,6 +36,12 @@Method for internal use.
@@ -206,6 +208,7 @@ CLASS ZCL_IBMX_SERVICE_EXT IMPLEMENTATION. * +-------------------------------------------------------------------------------------------------+ * | [--->] I_SERVICENAME TYPE TY_SERVICENAME * | [--->] I_INSTANCE_ID TYPE TY_INSTANCE_ID(optional) +* | [--->] I_PREFIX TYPE STRING(optional) * | [<-->] C_REQUEST_PROP TYPE ANY * +-------------------------------------------------------------------------------------- method add_config_prop. @@ -215,6 +218,7 @@ CLASS ZCL_IBMX_SERVICE_EXT IMPLEMENTATION. lv_type type char, ls_config type ZIBMX_config, lt_config type standard table of ZIBMX_config, + lv_param type ZIBMX_config-param, lt_ref type standard table of ref to data, lr_data type ref to data, lv_index type i value 0, @@ -281,7 +285,12 @@ CLASS ZCL_IBMX_SERVICE_EXT IMPLEMENTATION. append lr_data to lt_ref. else. if- "! The data returned when an error is encountered.
- begin of T_ERROR, - "! An identifier that can be used to trace the request. - TRACE type STRING, - "! The list of errors. - ERRORS type STANDARD TABLE OF T_ERROR_ITEM WITH NON-UNIQUE DEFAULT KEY, - end of T_ERROR. types: "!"! The context for prompt tuning metrics.
@@ -57,13 +38,44 @@ public section. end of T_METRICS_CONTEXT. types: "!- "! Optional messages related to the deployment.
+ "! Optional messages related to the resource. begin of T_MESSAGE, "! The level of the message, normally one of `debug`, `info` or `warning`. LEVEL type STRING, "! The message. TEXT type STRING, end of T_MESSAGE. + types: + "!+ "! The target of the error.
+ begin of T_API_ERROR_TARGET, + "! The type of the problematic field. + TYPE type STRING, + "! The name of the problematic field. + NAME type STRING, + end of T_API_ERROR_TARGET. + types: + "!+ "! An error message.
+ begin of T_API_ERROR, + "! A simple code that should convey the general sense of the error. + CODE type STRING, + "! The message that describes the error. + MESSAGE type STRING, + "! A reference to a more detailed explanation when available. + MORE_INFO type STRING, + "! The target of the error. + TARGET type T_API_ERROR_TARGET, + end of T_API_ERROR. + types: + "!+ "! The data returned when an error is encountered.
+ begin of T_API_ERROR_RESPONSE, + "! An identifier that can be used to trace the request. + TRACE type STRING, + "! The list of errors. + ERRORS type STANDARD TABLE OF T_API_ERROR WITH NON-UNIQUE DEFAULT KEY, + end of T_API_ERROR_RESPONSE. types: "!"! A metric.
@@ -87,13 +99,81 @@ public section. COMPLETED_AT type DATETIME, "! Current state of training. STATE type STRING, - "! Optional messages related to the deployment. + "! Optional messages related to the resource. MESSAGE type T_MESSAGE, "! Metrics that can be returned by an operation. METRICS type STANDARD TABLE OF T_TRAINING_METRIC WITH NON-UNIQUE DEFAULT KEY, "! The data returned when an error is encountered. - FAILURE type T_ERROR, + FAILURE type T_API_ERROR_RESPONSE, end of T_TRAINING_STATUS. + types: + "!+ "! The origin of a notebook from a source.
+ begin of T_NOTEBOOK_ORIGIN_FROM_SOURCE, + "! The orgin type of the notebook, either blank, file or url. + TYPE type STRING, + "! The guid of the source file. + GUID type STRING, + end of T_NOTEBOOK_ORIGIN_FROM_SOURCE. + types: + "!+ "! The number of epochs is the number of complete passes
+ "! through the training dataset. The quality depends on the number of epochs. + begin of T_TRAINING_NUM_EPOCHS, + "! The default value. + DEFAULT type INTEGER, + "! The minimum value. + MIN type INTEGER, + "! The maximum value. + MAX type INTEGER, + end of T_TRAINING_NUM_EPOCHS. + types: + "!+ "! The lifecycle details.
+ begin of T_LIFE_CYCLE_STATE, + "! The possible lifecycle stages, in order, are described below:+ "! The limits that may be set per request.
+ begin of T_CONSUMPTIONS_LIMIT, + "! The hard limit on the call time for a request, if set. + CALL_TIME type STRING, + "! The hard limit on the number of input tokens for a request, if set. A value of + "! zero will disable this feature. + MAX_INPUT_TOKENS type INTEGER, + "! The hard limit on the number of output tokens for a request, if set. A value of + "! zero will disable this feature. + MAX_OUTPUT_TOKENS type INTEGER, + end of T_CONSUMPTIONS_LIMIT. + types: + "!+ "! Initialization methods for a training.
+ begin of T_TRAINING_INIT_METHOD, + "! The supported initialization methods. + SUPPORTED type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! The default value, which will be one of the values from the `supported` field. + DEFAULT type STRING, + end of T_TRAINING_INIT_METHOD. types: "!"! The schema of the expected data, see
- "! Information related to the revision.
- begin of T_RESOURCE_COMMIT_INFO, - "! The time when the revision was committed. - COMMITTED_AT type DATETIME, - "! The message that was provided when the revision was created. - COMMIT_MESSAGE type STRING, - end of T_RESOURCE_COMMIT_INFO. + "! A notebook version entity in a project. + begin of T_NTBK_VER_ENTITY_IN_PROJECT, + "! The guid of the versioned notebook. + MASTER_NOTEBOOK_GUID type STRING, + "! The IUI of the user that has created the version. + CREATED_BY_IUI type STRING, + "! The file reference in the corresponding COS. + FILE_REFERENCE type STRING, + "! The revision id of the notebook. + REV_ID type INTEGER, + "! The guid of the project. + PROJECT_ID type STRING, + end of T_NTBK_VER_ENTITY_IN_PROJECT. + types: + "!+ "! Properties that control the moderation on the text.
+ begin of T_TEXT_MODERATION, + "! Should this moderation be enabled on the text.+ "! The properties specific to masking. If this object exists,
+ "! even if it is empty, then masking will be applied. + begin of T_MASK_PROPERTIES, + "! If this field is `true` then the entity value, that contains the text that was + "! masked, will also be removed from the output. + REMOVE_ENTITY_VALUE type BOOLEAN, + end of T_MASK_PROPERTIES. + types: + "!+ "! The properties specific to HAP.
+ begin of T_MDRTN_HAP_INPUT_PROPERTIES, + "! Properties that control the moderation on the text. + INPUT type T_TEXT_MODERATION, + "! The properties specific to masking. If this object exists,+ "! The top tokens.
+ begin of T_TEXT_GEN_TOP_TOKEN_INFO, + "! The token text. + TEXT type STRING, + "! The natural log of probability for the token. + LOGPROB type NUMBER, + end of T_TEXT_GEN_TOP_TOKEN_INFO. types: "!"! A warning message.
@@ -127,6 +254,8 @@ public section. MESSAGE type STRING, "! An `id` associated with the message. ID type STRING, + "! A reference to a more detailed explanation when available. + MORE_INFO type STRING, "! Additional key-value pairs that depend on the specific warning. ADDITIONAL_PROPERTIES type JSONOBJECT, end of T_WARNING. @@ -134,86 +263,368 @@ public section. "!"! Optional details coming from the service and related to the
"! API call or the associated resource. - begin of T_TRAIN_RSRC_COLLECTION_SYS, + begin of T_SYSTEM_DETAILS, "! Any warnings coming from the system. WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, - end of T_TRAIN_RSRC_COLLECTION_SYS. + end of T_SYSTEM_DETAILS. types: "!- "! Contains a set of fields specific to each connection. See
- "! here for [details about specifying connections](#datareferences). - T_DATA_CONNECTION type JSONOBJECT. + "! A range of text. + begin of T_MODERATION_TEXT_RANGE, + "! The start index of the range. + START type INTEGER, + "! The end index of the range. The end index is exclusive meaning that the + "! character at this index will not be included in the range. + END type INTEGER, + end of T_MODERATION_TEXT_RANGE. types: "!- "! A reference to data.
- begin of T_OBJECT_LOCATION, - "! Item identification inside a collection. - ID type STRING, - "! The data source type like `connection_asset` or `data_asset`. - TYPE type STRING, - "! Contains a set of fields specific to each connection.- "! The model id of the base model for this prompt tuning.
- begin of T_BASE_MODEL, - "! The model id of the base model. - MODEL_ID type STRING, - end of T_BASE_MODEL. + "! The result of any detected moderations. + begin of T_MODERATION_RESULTS, + "! The HAP results. + HAP type STANDARD TABLE OF T_MODERATION_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! The PII results. + PII type STANDARD TABLE OF T_MODERATION_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_MODERATION_RESULTS. types: "!- "! Common metadata for a resource where `project_id` or
- "! `space_id` must be present. - begin of T_RESOURCE_META, - "! The id of the resource. - ID type STRING, - "! The time when the resource was created. - CREATED_AT type DATETIME, - "! The revision of the resource. - REV type STRING, - "! The user id which created this resource. - OWNER type STRING, - "! The time when the resource was last modified. - MODIFIED_AT type DATETIME, - "! The id of the parent resource where applicable. - PARENT_ID type STRING, - "! The name of the resource. - NAME type STRING, - "! A description of the resource. - DESCRIPTION type STRING, - "! A list of tags for this resource. - TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Information related to the revision. - COMMIT_INFO type T_RESOURCE_COMMIT_INFO, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - end of T_RESOURCE_META. + "! The generated token. + begin of T_TEXT_GEN_TOKEN_INFO, + "! The token text. + TEXT type STRING, + "! The natural log of probability for the token. + LOGPROB type NUMBER, + "! The rank of the token relative to the other tokens. + RANK type INTEGER, + "! The top tokens. + TOP_TOKENS type STANDARD TABLE OF T_TEXT_GEN_TOP_TOKEN_INFO WITH NON-UNIQUE DEFAULT KEY, + end of T_TEXT_GEN_TOKEN_INFO. types: - "!- "! A reference to data with an optional data schema. If
- "! necessary, it is possible to provide a data connection that contains just the - "! data schema. - begin of T_DATA_CONNECTION_REFERENCE, - "! Optional item identification inside a collection. - ID type STRING, - "! The data source type like `connection_asset` or `data_asset`. If the data - "! connection contains just a schema then this field is not required. - TYPE type STRING, - "! Contains a set of fields specific to each connection.+ "! System details.
+ begin of T_TEXT_GEN_RESPONSE, + "! The `id` of the model for inference. + MODEL_ID type STRING, + "! The model version (using semantic versioning) if set. + MODEL_VERSION type STRING, + "! The time when the response was created. + CREATED_AT type DATETIME, + "! The generated tokens. + RESULTS type STANDARD TABLE OF T_TEXT_GEN_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! Optional details coming from the service and related to the API call or the + "! associated resource. + SYSTEM type T_SYSTEM_DETAILS, + end of T_TEXT_GEN_RESPONSE. + types: + "!+ "! The stats about deployments for a space.
+ begin of T_STATS, + "! An `id` associated with the space. + SPACE_ID type STRING, + "! The total number of deployments created in a space including `online` and + "! `batch`. + TOTAL_COUNT type NUMBER, + "! The number of online deployments created in a space. + ONLINE_COUNT type NUMBER, + "! The number of batch deployments created in a space. + BATCH_COUNT type NUMBER, + end of T_STATS. + types: + "!+ "! Optional details provided by the service about statistics of
+ "! the number of deployments created. The deployments that are counted will depend + "! on the request parameters. + begin of T_DEPLOYMENT_SYSTEM_DETAILS, + "! Any warnings coming from the system. + WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, + "! The stats about deployments. + STATS type STANDARD TABLE OF T_STATS WITH NON-UNIQUE DEFAULT KEY, + end of T_DEPLOYMENT_SYSTEM_DETAILS. + types: + "!+ "! System details including warnings.
+ begin of T_DEPLOYMENT_SYSTEM, + "! Optional details provided by the service about statistics of the number of + "! deployments created. The deployments that are counted will depend on the + "! request parameters. + SYSTEM type T_DEPLOYMENT_SYSTEM_DETAILS, + end of T_DEPLOYMENT_SYSTEM. + types: + "!+ "! The target of the error.
+ begin of T_ERROR_TARGET, + "! The type of the problematic field. + TYPE type STRING, + "! The name of the problematic field. + NAME type STRING, + end of T_ERROR_TARGET. + types: + "!+ "! An error object.
+ begin of T_ERROR, + "! The code describing the error. + CODE type STRING, + "! The detailed information about the error. + MESSAGE type STRING, + "! The target of the error. + TARGET type T_ERROR_TARGET, + end of T_ERROR. + types: + "!+ "! The space that contains the resource. Either `space_id` or
+ "! `project_id` has to be given. + T_SPACE_ID type String. + types: + "!+ "! The project that contains the resource. Either `space_id` or
+ "! `project_id` has to be given. + T_PROJECT_ID type String. + types: + "!+ "! A notebook kernel.
+ begin of T_NOTEBOOK_KERNEL, + "! The display name of the environment kernel. + DISPLAY_NAME type STRING, + "! The name of the environment kernel. + NAME type STRING, + "! The language of the environment kernel. + LANGUAGE type STRING, + end of T_NOTEBOOK_KERNEL. + types: + "!+ "! Metadata of a notebook.
+ begin of T_NOTEBOOK_METADATA, + "! The name of the notebook. + NAME type STRING, + "! A more verbose description. + DESCRIPTION type STRING, + "! Asset type, always "notebook". + ASSET_TYPE type STRING, + "! Creation date, ms since epoch. + CREATED type INTEGER, + "! Creation date, ISO format. + CREATED_AT type STRING, + "! IAM ID of the asset's owner. + OWNER_ID type STRING, + "! UUID of the asset's catalog. + CATALOG_ID type STRING, + "! UUID of the asset. + ASSET_ID type STRING, + end of T_NOTEBOOK_METADATA. + types: + "!+ "! A notebook runtime.
+ begin of T_NOTEBOOK_RUNTIME, + "! The guid of the environment on which the notebook runs. + ENVIRONMENT type STRING, + "! Spark monitoring enabled or not. + SPARK_MONITORING_ENABLED type BOOLEAN, + end of T_NOTEBOOK_RUNTIME. + types: + "!+ "! The notebook origin.
+ begin of T_NOTEBOOK_ORIGIN, + "! The orgin type of the notebook, either blank, file or url. + TYPE type STRING, + end of T_NOTEBOOK_ORIGIN. + types: + "!+ "! Definition part of a notebook entity.
+ begin of T_NOTEBOOK_ENTITY_DEFINITION, + "! A notebook kernel. + KERNEL type T_NOTEBOOK_KERNEL, + "! The notebook origin. + ORIGINATES_FROM type T_NOTEBOOK_ORIGIN, + end of T_NOTEBOOK_ENTITY_DEFINITION. + types: + "!+ "! Entity of a notebook.
+ begin of T_NOTEBOOK_ENTITY, + "! Definition part of a notebook entity. + NOTEBOOK type T_NOTEBOOK_ENTITY_DEFINITION, + "! A notebook runtime. + RUNTIME type T_NOTEBOOK_RUNTIME, + "! Full URI of the notebook. + HREF type STRING, + end of T_NOTEBOOK_ENTITY. + types: + "!+ "! Notebook information as returned by a GET request.
+ begin of T_NOTEBOOK, + "! Metadata of a notebook. + METADATA type T_NOTEBOOK_METADATA, + "! Entity of a notebook. + ENTITY type T_NOTEBOOK_ENTITY, + end of T_NOTEBOOK. + types: + "! No documentation available. + begin of T_WX_PRMPT_SSSN_ENTRY_LST_RSL1, + "! The prompt entry's ID. + ID type STRING, + "! The prompt entry's name. + NAME type STRING, + "! The prompt entry's description. + DESCRIPTION type STRING, + "! The prompt entry's create time in millis. + CREATED_AT type INTEGER, + end of T_WX_PRMPT_SSSN_ENTRY_LST_RSL1. + types: + "! No documentation available. + begin of T_WX_PROMPT_SESSION_ENTRY_LIST, + "! No documentation available. + RESULTS type STANDARD TABLE OF T_WX_PRMPT_SSSN_ENTRY_LST_RSL1 WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. + BOOKMARK type STRING, + end of T_WX_PROMPT_SESSION_ENTRY_LIST. + types: + "!+ "! Common metadata for a simple resource.
+ begin of T_RESOURCE_META_SIMPLE, + "! The id of the resource. + ID type STRING, + "! The time when the resource was created. + CREATED_AT type DATETIME, + end of T_RESOURCE_META_SIMPLE. + types: + "!+ "! Payload for copying a notebook.
+ begin of T_NOTEBOOK_COPY_BODY, + "! The name of the new notebook. + NAME type STRING, + "! The guid of the notebook to be copied. + SOURCE_GUID type STRING, + end of T_NOTEBOOK_COPY_BODY. + types: + "!+ "! The training details required when creating the job.
+ begin of T_TRAINING_RESOURCE_DETAILS, + "! The name of the training. + NAME type STRING, + "! The space that contains the resource. Either `space_id` or `project_id` has to + "! be given. + SPACE_ID type STRING, + "! The project that contains the resource. Either `space_id` or `project_id` has to + "! be given. + PROJECT_ID type STRING, + "! A description of the training. + DESCRIPTION type STRING, + "! A list of tags for this resource. + TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_TRAINING_RESOURCE_DETAILS. + types: + "!+ "! The properties specific to HAP.
+ begin of T_HAP_PROPERTIES, + "! The properties specific to masking. If this object exists,+ "! Information related to the revision.
+ begin of T_RESOURCE_COMMIT_INFO, + "! The time when the revision was committed. + COMMITTED_AT type DATETIME, + "! The message that was provided when the revision was created. + COMMIT_MESSAGE type STRING, + end of T_RESOURCE_COMMIT_INFO. + types: + "!+ "! Contains a set of fields specific to each connection. See
+ "! here for [details about specifying connections](#datareferences). + T_DATA_CONNECTION type JSONOBJECT. + types: + "!+ "! A reference to data.
+ begin of T_OBJECT_LOCATION, + "! Item identification inside a collection. + ID type STRING, + "! The data source type like `connection_asset` or `data_asset`. + TYPE type STRING, + "! Contains a set of fields specific to each connection.+ "! A reference to data with an optional data schema. If
+ "! necessary, it is possible to provide a data connection that contains just the + "! data schema. + begin of T_DATA_CONNECTION_REFERENCE, + "! Optional item identification inside a collection. + ID type STRING, + "! The data source type like `connection_asset` or `data_asset`. If the data + "! connection contains just a schema then this field is not required. + TYPE type STRING, + "! Contains a set of fields specific to each connection.+ "! The model id of the base model for this job.
+ begin of T_BASE_MODEL, + "! The model id of the base model. + MODEL_ID type STRING, + end of T_BASE_MODEL. types: "!"! Properties to control the prompt tuning.
begin of T_PROMPT_TUNING, - "! The model id of the base model for this prompt tuning. + "! The model id of the base model for this job. BASE_MODEL type T_BASE_MODEL, "! The task that is targeted for this model. TASK_ID type STRING, @@ -261,8 +679,22 @@ public section. end of T_PROMPT_TUNING. types: "!- "! Status of the training job.
- begin of T_TRAINING_RESOURCE_ENTITY, + "! The `training_data_references` contain the training datasets + "! and the- "! Training resource.
- begin of T_TRAINING_RESOURCE, - "! Common metadata for a resource where `project_id` or `space_id` must be present. - "! - METADATA type T_RESOURCE_META, - "! Status of the training job. - ENTITY type T_TRAINING_RESOURCE_ENTITY, - end of T_TRAINING_RESOURCE. + "! The parameters for text tokenization. + begin of T_TEXT_TOKENIZE_PARAMETERS, + "! If this is `true` then the actual tokens will also be returned in the response. + RETURN_TOKENS type BOOLEAN, + end of T_TEXT_TOKENIZE_PARAMETERS. types: "!- "! The reference to the first item in the current page.
- begin of T_PAGINATION_FIRST, - "! The uri of the first resource returned. - HREF type STRING, - end of T_PAGINATION_FIRST. + "! The input string to tokenize along with the associated model + "! id and any parameters. One of `space_id` or `project_id` must be provided. + begin of T_TEXT_TOKENIZE_REQUEST, + "! The space that contains the resource. Either `space_id` or `project_id` has to + "! be given. + SPACE_ID type STRING, + "! The project that contains the resource. Either `space_id` or `project_id` has to + "! be given. + PROJECT_ID type STRING, + "! The `id` of the model to be used for this request. Please refer to the [list of + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els.html?context=wx). + MODEL_ID type STRING, + "! The input string to tokenize. + INPUT type STRING, + "! The parameters for text tokenization. + PARAMETERS type T_TEXT_TOKENIZE_PARAMETERS, + end of T_TEXT_TOKENIZE_REQUEST. types: "!- "! A reference to the first item of the next page, if any.
- begin of T_PAGINATION_NEXT, - "! The uri of the next set of resources. - HREF type STRING, - end of T_PAGINATION_NEXT. + "! Runtime info returned with a notebook listing. + begin of T_NOTEBOOK_RESOURCE_ENTITY_RT, + "! If Spark monitoring is enabled. + SPARK_MONITORING_ENABLED type BOOLEAN, + "! UUID of the environment of the notebook. + ENVIRONMENT type STRING, + end of T_NOTEBOOK_RESOURCE_ENTITY_RT. types: "!- "! Information for paging when querying resources.
- begin of T_TRAINING_RESOURCE_COLLECTION, - "! The total number of resources. Computed explicitly only when - "! 'total_count=true' query parameter is present. This is in order to - "! avoid performance penalties. - TOTAL_COUNT type INTEGER, - "! The number of items to return in each page. - LIMIT type INTEGER, - "! The reference to the first item in the current page. - FIRST type T_PAGINATION_FIRST, - "! A reference to the first item of the next page, if any. - NEXT type T_PAGINATION_NEXT, - "! The training resources. - RESOURCES type STANDARD TABLE OF T_TRAINING_RESOURCE WITH NON-UNIQUE DEFAULT KEY, - "! Optional details coming from the service and related to the API call or the - "! associated resource. - SYSTEM type T_TRAIN_RSRC_COLLECTION_SYS, - end of T_TRAINING_RESOURCE_COLLECTION. + "! The tokens that are inferred from the prompt.- "! The number of epochs is the number of complete passes
- "! through the training dataset. The quality depends on the number of epochs. - begin of T_TRAINING_NUM_EPOCHS, - "! The default value. - DEFAULT type INTEGER, - "! The minimum value. - MIN type INTEGER, - "! The maximum value. - MAX type INTEGER, - end of T_TRAINING_NUM_EPOCHS. + "! Properties that control what is returned. + begin of T_RETURN_OPTION_PROPERTIES, + "! Include input text in the `generated_text` field. + INPUT_TEXT type BOOLEAN, + "! Include the list of individual generated tokens. Extra token information is + "! included based on the other flags below. + GENERATED_TOKENS type BOOLEAN, + "! Include the list of input tokens. Extra token information is included based on + "! the other flags here, but only for decoder-only models. + INPUT_TOKENS type BOOLEAN, + "! Include logprob (natural log of probability) for each returned token. Applicable + "! only if generated_tokens == true and/or input_tokens == true. + TOKEN_LOGPROBS type BOOLEAN, + "! Include rank of each returned token. Applicable only if generated_tokens == true + "! and/or input_tokens == true. + TOKEN_RANKS type BOOLEAN, + "! Include top n candidate tokens at the position of each returned token. The + "! maximum value permitted is 5, but more may be returned if there is a tie for + "! nth place. Applicable only if generated_tokens == true and/or input_tokens == + "! true. + TOP_N_TOKENS type INTEGER, + end of T_RETURN_OPTION_PROPERTIES. types: "!- "! The properties specific to masking. If this object exists,
- "! even if it is empty, then masking will be applied. - begin of T_MASK_PROPERTIES, - "! If this field is `true` then the entity value, that contains the text that was - "! masked, will also be removed from the output. - REMOVE_ENTITY_VALUE type BOOLEAN, - end of T_MASK_PROPERTIES. + "! The properties specific to HAP. + begin of T_MODERATION_HAP_PROPERTIES, + "! Properties that control the moderation on the text. + INPUT type T_TEXT_MODERATION, + "! Properties that control the moderation on the text. + OUTPUT type T_TEXT_MODERATION, + "! The properties specific to masking. If this object exists,"! The properties specific to PII.
- begin of T_PII_PROPERTIES, + begin of T_MODERATION_PII_PROPERTIES, + "! Properties that control the moderation on the text. + INPUT type T_TEXT_MODERATION, + "! Properties that control the moderation on the text. + OUTPUT type T_TEXT_MODERATION, "! The properties specific to masking. If this object exists,- "! The lifecycle details.
- begin of T_LIFE_CYCLE_STATE, - "! The possible lifecycle stages, in order, are described below:- "! The limits that may be set per request.
- begin of T_CONSUMPTIONS_LIMIT, - "! The hard limit on the call time for a request, if set. - CALL_TIME type STRING, - "! The hard limit on the number of input tokens for a request, if set. A value of - "! zero will disable this feature. - MAX_INPUT_TOKENS type INTEGER, - "! The hard limit on the number of output tokens for a request, if set. A value of - "! zero will disable this feature. - MAX_OUTPUT_TOKENS type INTEGER, - end of T_CONSUMPTIONS_LIMIT. - types: - "!- "! Initialization methods for a training.
- begin of T_TRAINING_INIT_METHOD, - "! The supported initialization methods. - SUPPORTED type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The default value, which will be one of the values from the `supported` field. - DEFAULT type STRING, - end of T_TRAINING_INIT_METHOD. - types: - "!- "! Maximum length of output tokens being predicted.
- begin of T_TRAINING_MAX_OUTPUT_TOKENS, - "! The default value. - DEFAULT type INTEGER, - "! The minimum value. - MIN type INTEGER, - "! The maximum value. - MAX type INTEGER, - end of T_TRAINING_MAX_OUTPUT_TOKENS. - types: - "!- "! Learning rate to be used for training.
- begin of T_TRAINING_LEARNING_RATE, - "! The default value. - DEFAULT type NUMBER, - "! The minimum value. - MIN type NUMBER, - "! The maximum value. - MAX type NUMBER, - end of T_TRAINING_LEARNING_RATE. - types: - "!- "! The batch size is a number of samples processed before the
- "! model is updated. - begin of T_TRAINING_BATCH_SIZE, - "! The default value. - DEFAULT type INTEGER, - "! The minimum value. - MIN type INTEGER, - "! The maximum value. - MAX type INTEGER, - end of T_TRAINING_BATCH_SIZE. + end of T_MODERATION_PII_PROPERTIES. types: "!- "! Number of virtual tokens to be used for training. In prompt
- "! tuning we are essentially learning the embedded representations for soft - "! prompts, which are known as virtual tokens, via back propagation for a specific - "! task(s) while keeping the rest of the model fixed. `num_virtual_tokens` is the - "! number of dimensions for these virtual tokens. - begin of T_TRAINING_NUM_VIRTUAL_TOKENS, - "! The possible values for the number of virtual tokens. - SUPPORTED type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, - "! The default number of virtual tokens. - DEFAULT type INTEGER, - end of T_TRAINING_NUM_VIRTUAL_TOKENS. + "! It can be used to exponentially increase the likelihood of + "! the text generation terminating once a specified number of tokens have been + "! generated. + begin of T_TEXT_GEN_LENGTH_PENALTY, + "! Represents the factor of exponential decay. Larger values correspond to more + "! aggressive decay. + DECAY_FACTOR type NUMBER, + "! A number of generated tokens after which this should take effect. + START_INDEX type INTEGER, + end of T_TEXT_GEN_LENGTH_PENALTY. types: "!- "! Number of steps to be used for gradient accumulation.
- "! Gradient accumulation refers to a method of collecting gradient for configured - "! number of steps instead of updating the model variables at every step and then - "! applying the update to model variables. This can be used as a tool to overcome - "! smaller batch size limitation. Often also referred in conjunction with - "! "effective batch size". - begin of T_TRAINING_ACCUMULATED_STEPS, - "! The default value. - DEFAULT type INTEGER, - "! The minimum value. - MIN type INTEGER, - "! The maximum value. - MAX type INTEGER, - end of T_TRAINING_ACCUMULATED_STEPS. + "! The template properties if this request refers to a prompt + "! template. + begin of T_DPLYMNT_TEXT_GEN_PROPERTIES, + "! Represents the strategy used for picking the tokens during generation of the + "! output text.- "! Datatype to use for training of the underlying text
- "! generation model. If no value is provided, we pull from torch_dtype in config. - "! If an in memory resource is provided which does not match the specified data - "! type, the model underpinning the resource will be converted in place to the - "! correct torch dtype. - begin of T_TRAINING_TORCH_DTYPE, - "! The datatype. - DEFAULT type STRING, - end of T_TRAINING_TORCH_DTYPE. + "! Properties that control the moderations, for usages such as + "! `Hate and profanity` (HAP) and `Personal identifiable information` (PII) + "! filtering. This list can be extended with new types of moderations. + begin of T_MODERATIONS, + "! The properties specific to HAP. + HAP type T_MODERATION_HAP_PROPERTIES, + "! The properties specific to PII. + PII type T_MODERATION_PII_PROPERTIES, + "! If set, then only these ranges will be applied to the moderations. This is + "! useful in the case that certain parts of the input text have already been + "! checked. + INPUT_RANGES type STANDARD TABLE OF T_MODERATION_TEXT_RANGE WITH NON-UNIQUE DEFAULT KEY, + end of T_MODERATIONS. types: - "!- "! Verbalizer template to be used for formatting data at train
- "! and inference time. This template may use brackets to indicate where fields - "! from the data model TrainGenerationRecord must be rendered. - begin of T_TRAINING_VERBALIZER, - "! The default verbalizer. - DEFAULT type STRING, - end of T_TRAINING_VERBALIZER. + "! No documentation available. + begin of T_DEPLOYMENT_TEXT_GEN, + "! The prompt to generate completions. Note: The method tokenizes the input + "! internally. It is recommended not to leave any trailing spaces.- "! Maximum length of input tokens being considered.
- begin of T_TRAINING_MAX_INPUT_TOKENS, - "! The default value. - DEFAULT type INTEGER, - "! The minimum value. - MIN type INTEGER, - "! The maximum value. - MAX type INTEGER, - end of T_TRAINING_MAX_INPUT_TOKENS. + "! The embedding values for a text string. The `input` field is + "! only set if the corresponding `return_option` is set. + begin of T_EMBEDDING, + "! The text input to the model. + INPUT type STRING, + "! The embedding values. + EMBEDDING type STANDARD TABLE OF NUMBER WITH NON-UNIQUE DEFAULT KEY, + end of T_EMBEDDING. types: "!- "! Initialization text to be used if init_method is set to
- "! `text`, otherwise this will be ignored. - begin of T_TRAINING_INIT_TEXT, - "! Initialization text. - DEFAULT type STRING, - end of T_TRAINING_INIT_TEXT. + "! The embeddings per input. + begin of T_EMBEDDINGS_RESPONSE_FIELDS, + "! The `id` of the model to be used for this request. Please refer to the [list of + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). + MODEL_ID type STRING, + "! The embedding values for a given text. + RESULTS type STANDARD TABLE OF T_EMBEDDING WITH NON-UNIQUE DEFAULT KEY, + "! The time when the response was created. + CREATED_AT type DATETIME, + "! The number of input tokens that were consumed. + INPUT_TOKEN_COUNT type INTEGER, + end of T_EMBEDDINGS_RESPONSE_FIELDS. types: - "!- "! Training parameters for a given model.
- begin of T_TRAINING_PARAMETERS, - "! Initialization methods for a training. - INIT_METHOD type T_TRAINING_INIT_METHOD, - "! Initialization text to be used if init_method is set to `text`, otherwise this - "! will be ignored. - INIT_TEXT type T_TRAINING_INIT_TEXT, - "! Number of virtual tokens to be used for training.- "! The ratings for this task for this model.
- begin of T_TASK_RATING, - "! A metric that indicates the cost expected to be incurred by the model's - "! support of an inference task, in terms of resource consumption and processing - "! time, on a scale of 1 to 5, where 5 is the least cost and 1 is the most cost. A - "! missing value means that the cost is not known. - COST type INTEGER, - "! A metric that indicates the quality of the model's support of an inference - "! task, on a scale of 1 to 5, where 5 is the best support and 1 is poor support. - "! A missing value means that the quality is not known. - QUALITY type INTEGER, - end of T_TASK_RATING. + "! No documentation available. + begin of T_EXTRNL_INFRMTN_EXTRNL_PROMPT, + "! No documentation available. + URL type STRING, + "! No documentation available. + ADDITIONAL_INFORMATION type STANDARD TABLE OF T_Array WITH NON-UNIQUE DEFAULT KEY, + end of T_EXTRNL_INFRMTN_EXTRNL_PROMPT. types: - "!- "! The attributes of the task for this model.
- begin of T_TASK_DESCRIPTION, - "! The `id` of the task. - ID type STRING, - "! The ratings for this task for this model. - RATINGS type T_TASK_RATING, - "! The tags for a given task. - TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_TASK_DESCRIPTION. + "! No documentation available. + begin of T_EXTERNAL_INFORMATION, + "! No documentation available. + EXTERNAL_PROMPT_ID type STRING, + "! No documentation available. + EXTERNAL_MODEL_ID type STRING, + "! No documentation available. + EXTERNAL_MODEL_PROVIDER type STRING, + "! No documentation available. + EXTERNAL_PROMPT type T_EXTRNL_INFRMTN_EXTRNL_PROMPT, + "! No documentation available. + EXTERNAL_MODEL type T_EXTRNL_INFRMTN_EXTRNL_MODEL, + end of T_EXTERNAL_INFORMATION. types: - "!- "! A minor or patch version for the model.
- begin of T_FOUNDATION_MODEL_VERSION, - "! The version of the model. This must follow semantic versioning semantics. - VERSION type STRING, - "! The date (ISO 8601 format YYYY-MM-DD) when this version first became available. - AVAILABLE_DATE type DATE, - end of T_FOUNDATION_MODEL_VERSION. + "! No documentation available. + begin of T_CHAT_ITEM, + "! No documentation available. + TYPE type STRING, + "! No documentation available. + CONTENT type STRING, + "! No documentation available. + STATUS type STRING, + "! No documentation available. + TIMESTAMP type INTEGER, + end of T_CHAT_ITEM. types: - "!- "! The limits that are applied for the model, for all the
- "! plans. - begin of T_MODEL_LIMITS, - "! This is the maximum allowed value for the number of tokens in the input prompt - "! plus the number of tokens in the output generated by the model. - MAX_SEQUENCE_LENGTH type INTEGER, - "! This is the maximum number of records that can be accepted when training this - "! model. - TRAINING_DATA_MAX_RECORDS type INTEGER, - end of T_MODEL_LIMITS. + "! No documentation available. + begin of T_PRMPT_WTH_EXTRNL_MODEL_PARAM, + "! No documentation available. + DECODING_METHOD type STRING, + "! No documentation available. + MAX_NEW_TOKENS type INTEGER, + "! No documentation available. + MIN_NEW_TOKENS type INTEGER, + "! No documentation available. + RANDOM_SEED type INTEGER, + "! No documentation available. + STOP_SEQUENCES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. + TEMPERATURE type NUMBER, + "! No documentation available. + TOP_K type NUMBER, + "! No documentation available. + TOP_P type NUMBER, + "! No documentation available. + REPETITION_PENALTY type NUMBER, + end of T_PRMPT_WTH_EXTRNL_MODEL_PARAM. types: - "!- "! Limits per plan that may be set per request.
- begin of T_FOUNDATION_MODEL_LIMITS, - "! The limits that may be set per request. - LITE type T_CONSUMPTIONS_LIMIT, - end of T_FOUNDATION_MODEL_LIMITS. + "! No documentation available. + begin of T_PROMPT_DATA, + "! No documentation available. + INSTRUCTION type STRING, + "! No documentation available. + INPUT_PREFIX type STRING, + "! No documentation available. + OUTPUT_PREFIX type STRING, + "! No documentation available. + EXAMPLES type STANDARD TABLE OF T_Array WITH NON-UNIQUE DEFAULT KEY, + end of T_PROMPT_DATA. types: - "!- "! A supported foundation model.
- begin of T_FOUNDATION_MODEL, - "! The id of the foundation model. + "! No documentation available. + begin of T_PROMPT_WITH_EXTERNAL, + "! No documentation available. + INPUT type STANDARD TABLE OF T_Array WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. MODEL_ID type STRING, - "! A short label that will be displayed in the UI. - LABEL type STRING, - "! The provider of the model. - PROVIDER type STRING, - "! The organization or person that tuned this model. - TUNED_BY type STRING, - "! A short description of the model suitable for a title. - SHORT_DESCRIPTION type STRING, - "! A longer description of the model, that may be used if no `description_url` is - "! provided. - LONG_DESCRIPTION type STRING, - "! Limits per plan that may be set per request. - LIMITS type T_FOUNDATION_MODEL_LIMITS, - "! Deprecated: please use `tasks` instead. - TASK_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The tasks that are supported by this model. - TASKS type STANDARD TABLE OF T_TASK_DESCRIPTION WITH NON-UNIQUE DEFAULT KEY, - "! The tier of the model, depending on the `tier` the billing will be different, - "! refer to the plan for the details. - TIER type STRING, - "! Specifies the provider of this model. - SOURCE type STRING, - "! The minimum number of examples required for the model. - MIN_SHOT_SIZE type INTEGER, - "! The number of parameters used for the model, it will accept `m` for million, `b` - "! for billion and `t` for trillion. - NUMBER_PARAMS type STRING, - "! The limits that are applied for the model, for all the plans. - MODEL_LIMITS type T_MODEL_LIMITS, - "! The information related to the lifecycle of this model. - LIFECYCLE type STANDARD TABLE OF T_LIFE_CYCLE_STATE WITH NON-UNIQUE DEFAULT KEY, - "! Training parameters for a given model. - TRAINING_PARAMETERS type T_TRAINING_PARAMETERS, - "! The information related to the minor versions of this model. - VERSIONS type STANDARD TABLE OF T_FOUNDATION_MODEL_VERSION WITH NON-UNIQUE DEFAULT KEY, - end of T_FOUNDATION_MODEL. + "! No documentation available. + MODEL_PARAMETERS type T_PRMPT_WTH_EXTRNL_MODEL_PARAM, + "! No documentation available. + DATA type T_PROMPT_DATA, + "! No documentation available. + SYSTEM_PROMPT type STRING, + "! No documentation available. + CHAT_ITEMS type STANDARD TABLE OF T_CHAT_ITEM WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. + EXTERNAL_INFORMATION type T_EXTERNAL_INFORMATION, + end of T_PROMPT_WITH_EXTERNAL. types: "!- "! The prompt variables.
- T_PROMPT_VARIABLES type MAP. + "! A reference to a resource. + begin of T_SIMPLE_REL, + "! The id of the referenced resource. + ID type STRING, + end of T_SIMPLE_REL. types: "!- "! A range of text.
- begin of T_MODERATION_TEXT_RANGE, - "! The start index of the range. - START type INTEGER, - "! The end index of the range. The end index is exclusive meaning that the - "! character at this index will not be included in the range. - END type INTEGER, - end of T_MODERATION_TEXT_RANGE. + "! The return options for text embeddings. + begin of T_EMBEDDING_RETURN_OPTIONS, + "! Include the `input` text in each of the `results` documents. + INPUT_TEXT type BOOLEAN, + end of T_EMBEDDING_RETURN_OPTIONS. types: "!- "! A specific moderation result.
- begin of T_MODERATION_RESULT, - "! the probability that this is a real match. - SCORE type FLOAT, - "! This defines if this was found in the input (`true`) or the output (`false`). - INPUT type BOOLEAN, - "! A range of text. - POSITION type T_MODERATION_TEXT_RANGE, - "! The entity that was identified by the moderation. - ENTITY type STRING, - "! The text that was identified for this entity.- "! The result of any detected moderations.
- begin of T_MODERATION_RESULTS, - "! The HAP results. - HAP type STANDARD TABLE OF T_MODERATION_RESULT WITH NON-UNIQUE DEFAULT KEY, - "! The PII results. - PII type STANDARD TABLE OF T_MODERATION_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_MODERATION_RESULTS. + "! Metrics that can be returned by an operation. + T_TRAINING_METRICS type STANDARD TABLE OF T_TRAINING_METRIC WITH NON-UNIQUE DEFAULT KEY. types: - "!- "! A warning message.
- begin of T_WARNING_TG, - "! The message. - MESSAGE type STRING, - "! An `id` associated with the message. - ID type STRING, - "! A reference to a more detailed explanation when available. - MORE_INFO type STRING, - end of T_WARNING_TG. + "! No documentation available. + T_PROMPT_VARIABLE type JSONOBJECT. types: - "!- "! The top tokens.
- begin of T_TEXT_GEN_TOP_TOKEN_INFO, - "! The token text. - TEXT type STRING, - "! The natural log of probability for the token. - LOGPROB type NUMBER, - end of T_TEXT_GEN_TOP_TOKEN_INFO. + "! No documentation available. + T_NOTEBOOK_VERSIONS_LST_RESP type JSONOBJECT. types: "!- "! The generated token.
- begin of T_TEXT_GEN_TOKEN_INFO, - "! The token text. - TEXT type STRING, - "! The natural log of probability for the token. - LOGPROB type NUMBER, - "! The rank of the token relative to the other tokens. - RANK type INTEGER, - "! The top tokens. - TOP_TOKENS type STANDARD TABLE OF T_TEXT_GEN_TOP_TOKEN_INFO WITH NON-UNIQUE DEFAULT KEY, - end of T_TEXT_GEN_TOKEN_INFO. + "! Contains a set of fields that describe the location of the + "! data with respect to the `connection`. + T_DATA_LOCATION type MAP. types: - "! No documentation available. - begin of T_TEXT_GEN_RESULT, - "! The text that was generated by the model. - GENERATED_TEXT type STRING, - "! The number of generated tokens. - GENERATED_TOKEN_COUNT type INTEGER, - "! The number of input tokens consumed. - INPUT_TOKEN_COUNT type INTEGER, - "! The reason why the call stopped, can be one of:+ "! A set of key-value pairs that are used to configure the
+ "! deployment. + begin of T_ONLINE_DEPLOYMENT_PARAMETERS, + "! The `serving_name` can be used in the inference URL in place of the + "! `deployment_id`. + SERVING_NAME type STRING, + end of T_ONLINE_DEPLOYMENT_PARAMETERS. types: "!- "! Optional details coming from the service and related to the
- "! API call or the associated resource. - begin of T_SYSTEM_TG_DETAILS, - "! Any warnings coming from the system. - WARNINGS type STANDARD TABLE OF T_WARNING_TG WITH NON-UNIQUE DEFAULT KEY, - end of T_SYSTEM_TG_DETAILS. + "! Indicates that this is an online deployment. An object has + "! to be specified but can be empty. The `serving_name` can be provided in the + "! `online.parameters`. + begin of T_ONLINE_DEPLOYMENT, + "! A set of key-value pairs that are used to configure the deployment. + PARAMETERS type T_ONLINE_DEPLOYMENT_PARAMETERS, + end of T_ONLINE_DEPLOYMENT. types: "!- "! System details.
- begin of T_TEXT_GEN_RESPONSE, - "! The `id` of the model for inference. - MODEL_ID type STRING, - "! The model version (using semantic versioning) if set. - MODEL_VERSION type STRING, - "! The time when the response was created. - CREATED_AT type DATETIME, - "! The generated tokens. - RESULTS type STANDARD TABLE OF T_TEXT_GEN_RESULT WITH NON-UNIQUE DEFAULT KEY, - "! Optional details coming from the service and related to the API call or the - "! associated resource. - SYSTEM type T_SYSTEM_TG_DETAILS, - end of T_TEXT_GEN_RESPONSE. + "! A hardware specification. + begin of T_HARDWARE_SPEC, + "! The id of the hardware specification. + ID type STRING, + "! The revision of the hardware specification. + REV type STRING, + "! The name of the hardware specification. + NAME type STRING, + "! The number of nodes applied to a computation. + NUM_NODES type INTEGER, + end of T_HARDWARE_SPEC. + types: + "!+ "! A reference to a resource.
+ begin of T_REL, + "! The id of the referenced resource. + ID type STRING, + "! The revision of the referenced resource. + REV type STRING, + end of T_REL. types: "!- "! A task that is covered by some of the foundation models that
- "! are supported in the service. - begin of T_FOUNDATION_MODEL_TASK, - "! The id of the task. - TASK_ID type STRING, - "! The label of the task. - LABEL type STRING, - "! The description of the task. + "! The deployment request entity (this description is not + "! used). + begin of T_DPLYMNT_RESOURCE_PROTOTYPE, + "! The name of the resource. + NAME type STRING, + "! The project that contains the resource. Either `space_id` or `project_id` has to + "! be given. + PROJECT_ID type STRING, + "! The space that contains the resource. Either `space_id` or `project_id` has to + "! be given. + SPACE_ID type STRING, + "! A description of the resource. DESCRIPTION type STRING, - "! The rank of the task that is mainly for the UI. - RANK type INTEGER, - end of T_FOUNDATION_MODEL_TASK. + "! A list of tags for this resource. + TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! User defined properties specified as key-value pairs. + CUSTOM type JSONOBJECT, + "! A reference to a resource. + ASSET type T_REL, + "! A reference to a resource. + PROMPT_TEMPLATE type T_SIMPLE_REL, + "! Indicates that this is an online deployment. An object has to be specified but + "! can be empty.- "! The supported foundation model tasks.
- T_FOUNDATION_MODEL_TASKS_ARRAY type STANDARD TABLE OF T_FOUNDATION_MODEL_TASK WITH NON-UNIQUE DEFAULT KEY. + "! A notebook version entity. + begin of T_NOTEBOOK_VERSION_ENTITY, + "! The guid of the versioned notebook. + MASTER_NOTEBOOK_GUID type STRING, + "! The IUI of the user that has created the version. + CREATED_BY_IUI type STRING, + "! The file reference in the corresponding COS. + FILE_REFERENCE type STRING, + "! The revision id of the notebook. + REV_ID type INTEGER, + end of T_NOTEBOOK_VERSION_ENTITY. types: "!- "! The stats about deployments for a space.
- begin of T_STATS, - "! An `id` associated with the space. - SPACE_ID type STRING, - "! The total number of deployments created in a space including `online` and - "! `batch`. - TOTAL_COUNT type NUMBER, - "! The number of online deployments created in a space. - ONLINE_COUNT type NUMBER, - "! The number of batch deployments created in a space. - BATCH_COUNT type NUMBER, - end of T_STATS. + "! Payload for creating a notebook. + begin of T_NOTEBOOK_CREATE_BODY_GENERAL, + "! The name of the new notebook. + NAME type STRING, + "! A more verbose description of the notebook. + DESCRIPTION type STRING, + "! The reference to the file in the object storage. + FILE_REFERENCE type STRING, + "! The notebook origin. + ORIGINATES_FROM type T_NOTEBOOK_ORIGIN, + "! A notebook runtime. + RUNTIME type T_NOTEBOOK_RUNTIME, + "! A notebook kernel. + KERNEL type T_NOTEBOOK_KERNEL, + end of T_NOTEBOOK_CREATE_BODY_GENERAL. types: - "!- "! Optional details provided by the service about statistics of
- "! the number of deployments created. The deployments that are counted will depend - "! on the request parameters. - begin of T_DEPLOYMENT_SYSTEM_DETAILS, - "! Any warnings coming from the system. - WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, - "! The stats about deployments. - STATS type STANDARD TABLE OF T_STATS WITH NON-UNIQUE DEFAULT KEY, - end of T_DEPLOYMENT_SYSTEM_DETAILS. + "! No documentation available. + begin of T_PROMPT_MODEL_PARAMETERS, + "! No documentation available. + DECODING_METHOD type STRING, + "! No documentation available. + MAX_NEW_TOKENS type INTEGER, + "! No documentation available. + MIN_NEW_TOKENS type INTEGER, + "! No documentation available. + RANDOM_SEED type INTEGER, + "! No documentation available. + STOP_SEQUENCES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. + TEMPERATURE type NUMBER, + "! No documentation available. + TOP_K type NUMBER, + "! No documentation available. + TOP_P type NUMBER, + "! No documentation available. + REPETITION_PENALTY type NUMBER, + end of T_PROMPT_MODEL_PARAMETERS. types: "!- "! System details including warnings.
- begin of T_DEPLOYMENT_SYSTEM, - "! Optional details provided by the service about statistics of the number of - "! deployments created. The deployments that are counted will depend on the - "! request parameters. - SYSTEM type T_DEPLOYMENT_SYSTEM_DETAILS, - end of T_DEPLOYMENT_SYSTEM. + "! The reference to the first item in the current page. + begin of T_PAGINATION_FIRST, + "! The uri of the first resource returned. + HREF type STRING, + end of T_PAGINATION_FIRST. types: "!- "! The space that contains the resource. Either `space_id` or
- "! `project_id` has to be given. - T_SPACE_ID type String. + "! A reference to the first item of the next page, if any. + begin of T_PAGINATION_NEXT, + "! The uri of the next set of resources. + HREF type STRING, + end of T_PAGINATION_NEXT. types: "!- "! The project that contains the resource. Either `space_id` or
- "! `project_id` has to be given. - T_PROJECT_ID type String. + "! Information for paging when querying resources. + begin of T_PAGINATION, + "! The total number of resources. Computed explicitly only when + "! 'total_count=true' query parameter is present. This is in order to + "! avoid performance penalties. + TOTAL_COUNT type INTEGER, + "! The number of items to return in each page. + LIMIT type INTEGER, + "! The reference to the first item in the current page. + FIRST type T_PAGINATION_FIRST, + "! A reference to the first item of the next page, if any. + NEXT type T_PAGINATION_NEXT, + end of T_PAGINATION. types: "!- "! Common metadata for a resource.
- begin of T_RESOURCE_META_BASE, + "! Common metadata for a resource where `project_id` or + "! `space_id` must be present. + begin of T_RESOURCE_META, + "! The id of the resource. + ID type STRING, + "! The time when the resource was created. + CREATED_AT type DATETIME, "! The revision of the resource. REV type STRING, "! The user id which created this resource. @@ -865,818 +1286,943 @@ public section. TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, "! Information related to the revision. COMMIT_INFO type T_RESOURCE_COMMIT_INFO, - end of T_RESOURCE_META_BASE. + "! The space that contains the resource. Either `space_id` or `project_id` has to + "! be given. + SPACE_ID type STRING, + "! The project that contains the resource. Either `space_id` or `project_id` has to + "! be given. + PROJECT_ID type STRING, + end of T_RESOURCE_META. + types: + "! No documentation available. + begin of T_RESULTS_REFERENCE_INPUT, + "! The training results. Normally this is specified as `type=container` which- "! Common metadata for a simple resource.
- begin of T_RESOURCE_META_SIMPLE, - "! The id of the resource. - ID type STRING, - "! The time when the resource was created. - CREATED_AT type DATETIME, - end of T_RESOURCE_META_SIMPLE. + "! Notebook version metadata. + begin of T_NOTEBOOK_VERSION_METADATA, + "! The guid of the version. + GUID type STRING, + "! The URL of the version. + URL type STRING, + "! The creation timestamp in UTC millisecond since UNIX Epoch time. + CREATED_AT type INTEGER, + end of T_NOTEBOOK_VERSION_METADATA. types: "!- "! The AutoRAG metrics, this contains the list of calculated
- "! metrics on test data (provided in the request) and (optionally) synthetic data - "! autogenerated. Metric value is mean value calculated over all records in the - "! dataset. - begin of T_AUTO_RAGMETRICS, - "! The metrics for the test data that was provided in the request. - TEST_DATA type MAP, - "! The metrics for the synthetic data, if autogenerated. - SYNTHETIC_DATA type MAP, - end of T_AUTO_RAGMETRICS. + "! A notebook version in a project. + begin of T_NOTEBOOK_VERSION_IN_PROJECT, + "! Notebook version metadata. + METADATA type T_NOTEBOOK_VERSION_METADATA, + "! A notebook version entity in a project. + ENTITY type T_NTBK_VER_ENTITY_IN_PROJECT, + end of T_NOTEBOOK_VERSION_IN_PROJECT. types: "!- "! The training details required when creating the job.
- begin of T_TRAINING_RESOURCE_DETAILS, - "! The name of the training. + "! A notebook version in a project. + begin of T_NTBK_VER_CRE_RESP_NTBK_VER_1, + "! Notebook version metadata. + METADATA type T_NOTEBOOK_VERSION_METADATA, + "! A notebook version entity in a project. + ENTITY type T_NTBK_VER_ENTITY_IN_PROJECT, + end of T_NTBK_VER_CRE_RESP_NTBK_VER_1. + types: + "!+ "! Metadata of a notebook in a project.
+ begin of T_NOTEBOOK_METADATA_IN_PROJECT, + "! The name of the notebook. NAME type STRING, + "! A more verbose description. + DESCRIPTION type STRING, + "! Asset type, always "notebook". + ASSET_TYPE type STRING, + "! Creation date, ms since epoch. + CREATED type INTEGER, + "! Creation date, ISO format. + CREATED_AT type STRING, + "! IAM ID of the asset's owner. + OWNER_ID type STRING, + "! UUID of the asset's catalog. + CATALOG_ID type STRING, + "! UUID of the asset. + ASSET_ID type STRING, + "! UUID of the asset's project. + PROJECT_ID type STRING, + end of T_NOTEBOOK_METADATA_IN_PROJECT. + types: + "!+ "! Notebook information in a project as returned by a GET
+ "! request. + begin of T_NOTEBOOK_IN_PROJECT, + "! Metadata of a notebook in a project. + METADATA type T_NOTEBOOK_METADATA_IN_PROJECT, + "! Entity of a notebook. + ENTITY type T_NOTEBOOK_ENTITY, + end of T_NOTEBOOK_IN_PROJECT. + types: + "!+ "! The limits that are applied for the model, for all the
+ "! plans. + begin of T_MODEL_LIMITS, + "! This is the maximum allowed value for the number of tokens in the input prompt + "! plus the number of tokens in the output generated by the model. + MAX_SEQUENCE_LENGTH type INTEGER, + "! This is the maximum number of records that can be accepted when training this + "! model. + TRAINING_DATA_MAX_RECORDS type INTEGER, + end of T_MODEL_LIMITS. + types: + "!+ "! The details of an inference API.
+ begin of T_INFERENCE, + "! The inference URL. + URL type STRING, + "! This is `true` if the inference API supports SSE streaming. + SSE type BOOLEAN, + "! This is `true` if the inference API uses the `serving_name` that was defined in + "! this deployment. + USES_SERVING_NAME type BOOLEAN, + end of T_INFERENCE. + types: + "!+ "! Specifies the current status, additional information about
+ "! the deployment and any failure messages in case of deployment failures. + begin of T_DEPLOYMENT_STATUS, + "! Specifies the current state of the deployment. + STATE type STRING, + "! Optional messages related to the resource. + MESSAGE type T_MESSAGE, + "! The data returned when an error is encountered. + FAILURE type T_API_ERROR_RESPONSE, + "! The URLs that can be used to submit inference API requests. These URLs will + "! contain the+ "! The tier of the model, depending on the `tier` the billing
+ "! will be different, refer to the plan for the details. Note that input tokens + "! and output tokens may be charged differently. + T_FOUNDATION_MODEL_TIER type String. + types: + "!+ "! User defined properties specified as key-value pairs.
+ T_CUSTOM type JSONOBJECT. + types: + "!+ "! The `id` of the model to be used for this request. Please
+ "! refer to the [list of + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). + T_EMBEDDING_MODEL_ID type String. + types: + "!+ "! The batch size is a number of samples processed before the
+ "! model is updated. + begin of T_TRAINING_BATCH_SIZE, + "! The default value. + DEFAULT type INTEGER, + "! The minimum value. + MIN type INTEGER, + "! The maximum value. + MAX type INTEGER, + end of T_TRAINING_BATCH_SIZE. + types: + "!+ "! The text input for a given model to be used to generate the
+ "! embeddings. + begin of T_EMBEDDINGS_REQUEST, "! The space that contains the resource. Either `space_id` or `project_id` has to "! be given. SPACE_ID type STRING, "! The project that contains the resource. Either `space_id` or `project_id` has to "! be given. PROJECT_ID type STRING, - "! A description of the training. + "! The `id` of the model to be used for this request. Please refer to the [list of + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). + MODEL_ID type STRING, + "! The input text. + INPUTS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! Parameters for text embedding requests. + PARAMETERS type T_EMBEDDING_PARAMETERS, + end of T_EMBEDDINGS_REQUEST. + types: + "! No documentation available. + T_NOTEBOOK_VER_RETRIEVE_RESP type JSONOBJECT. + types: + "! No documentation available. + begin of T_WX_PROMPT_POST_MODEL_VERSION, + "! User provided semvar version for tracking in IBM AI Factsheets. + NUMBER type STRING, + "! User provived tag. + TAG type STRING, + "! Description of the version. DESCRIPTION type STRING, - "! A list of tags for this resource. - TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_TRAINING_RESOURCE_DETAILS. + end of T_WX_PROMPT_POST_MODEL_VERSION. types: "!- "! The properties specific to HAP.
- begin of T_HAP_PROPERTIES, - "! The properties specific to masking. If this object exists,- "! The location of the different result files.
- begin of T_AUTO_RAGRESULT_LOCATION, - "! The csv file with questions, answers, retrieved contexts, ground_truths and - "! metric scores. - EVALUATION_RESULTS type STRING, - "! The pickled python score function containing steps required to generate answers - "! to questions. - FUNCTION type STRING, - "! The location of the function source code. - FUNCTION_SOURCE_CODE type STRING, - "! The metadata of the function required to store the function in the repository. - FUNCTION_CREATION_REQUEST type STRING, - "! A Jupyter notebook with code required to build the index in the vector database. - "! - INDEXING_NOTEBOOK type STRING, - "! The Jupyter notebook with the python function code and steps required to store - "! and deploy the RAG pattern. - GENERATE_NOTEBOOK type STRING, - end of T_AUTO_RAGRESULT_LOCATION. + "! The properties specific to `watsonx.ai` deployments. + begin of T_DEPLOYMENT_RESOURCE_ENTITY, + "! The base model that is required for this deployment if this is for a prompt + "! template or a prompt tune for an IBM foundation model. + BASE_MODEL_ID type STRING, + end of T_DEPLOYMENT_RESOURCE_ENTITY. + types: + "!+ "! Payload for a request to revert to a specific notebook
+ "! version. + begin of T_NOTEBOOK_REVERT_BODY, + "! The guid of the notebook version. + SOURCE type STRING, + end of T_NOTEBOOK_REVERT_BODY. types: "!- "! The return options for text similarity.
- T_SIMILARITY_RETURN_OPTIONS type JSONOBJECT. + "! A text to rank. + begin of T_RERANK_INPUT, + "! The text to rank. + TEXT type STRING, + end of T_RERANK_INPUT. types: "!- "! Parameters for text similarity.
- begin of T_SIMILARITY_PARAMETERS, - "! Fail the call if the number of input tokens exceeds the allowed value. This - "! value can not be greater than the maximum sequence length that the model - "! supports. - TRUNCATE_INPUT_TOKENS type INTEGER, - "! The return options for text similarity. - RETURN_OPTIONS type T_SIMILARITY_RETURN_OPTIONS, - end of T_SIMILARITY_PARAMETERS. + "! The ranking score for the input. + begin of T_RERANKED_RESULTS, + "! A text to rank. + INPUT type T_RERANK_INPUT, + "! The score of the input. + SCORE type NUMBER, + end of T_RERANKED_RESULTS. types: "!- "! The source and target text that will be checked for
- "! similarity. - begin of T_SIMILARITY_REQUEST, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, + "! The ranked results. + begin of T_RERANK_RESPONSE_FIELDS, "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). MODEL_ID type STRING, - "! A source text. - SOURCE_TEXT type STRING, - "! The target texts. - TARGET_TEXTS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Parameters for text similarity. - PARAMETERS type T_SIMILARITY_PARAMETERS, - end of T_SIMILARITY_REQUEST. + "! The rank query. + QUERY type STRING, + "! The ranked results. + RESULTS type STANDARD TABLE OF T_RERANKED_RESULTS WITH NON-UNIQUE DEFAULT KEY, + "! The time when the response was created. + CREATED_AT type DATETIME, + "! The number of input tokens that were consumed. + INPUT_TOKEN_COUNT type INTEGER, + end of T_RERANK_RESPONSE_FIELDS. types: "!- "! Properties that control the moderation on the text.
- begin of T_TEXT_MODERATION, - "! Should this moderation be enabled on the text.- "! The properties for the moderation. Each type of moderation
- "! may have additional properties that are specific to that moderation. - begin of T_MODERATION_PROPERTIES, + "! The similarity scores per source string. + begin of T_SIMILARITY_RESPONSE_FIELDS, + "! The `id` of the model to be used for this request. Please refer to the [list of + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). + MODEL_ID type STRING, + "! The similarity scores. + RESULTS type STANDARD TABLE OF T_SIMILARITY_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! The time when the response was created. + CREATED_AT type DATETIME, + "! The number of input tokens that were consumed. + INPUT_TOKEN_COUNT type INTEGER, + end of T_SIMILARITY_RESPONSE_FIELDS. + types: + "!+ "! The properties specific to PII.
+ begin of T_MDRTN_PII_INPUT_PROPERTIES, "! Properties that control the moderation on the text. INPUT type T_TEXT_MODERATION, - "! Properties that control the moderation on the text. - OUTPUT type T_TEXT_MODERATION, - end of T_MODERATION_PROPERTIES. + "! The properties specific to masking. If this object exists,- "! The `training_data_references` contain the training datasets
- "! and the+ "! The definition of the deployment.
+ begin of T_DEPLOYMENT_ENTITY, "! User defined properties specified as key-value pairs. CUSTOM type JSONOBJECT, - "! If set to `true` then the result of the training, if successful, will be - "! uploaded to the repository as a model. - AUTO_UPDATE_MODEL type BOOLEAN, - "! The training results. Normally this is specified as `type=container` which - "! means- "! The parameters for text tokenization.
- begin of T_TEXT_TOKENIZE_PARAMETERS, - "! If this is `true` then the actual tokens will also be returned in the response. - RETURN_TOKENS type BOOLEAN, - end of T_TEXT_TOKENIZE_PARAMETERS. + "! Notebook information in a project as returned by a GET + "! request. + begin of T_NTBK_CRE_RESP_NTBK_IN_PRJCT, + "! Metadata of a notebook in a project. + METADATA type T_NOTEBOOK_METADATA_IN_PROJECT, + "! Entity of a notebook. + ENTITY type T_NOTEBOOK_ENTITY, + end of T_NTBK_CRE_RESP_NTBK_IN_PRJCT. types: "!- "! The input string to tokenize along with the associated model
- "! id and any parameters. One of `space_id` or `project_id` must be provided. - begin of T_TEXT_TOKENIZE_REQUEST, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod - "! els.html?context=wx). - MODEL_ID type STRING, - "! The input string to tokenize. - INPUT type STRING, - "! The parameters for text tokenization. - PARAMETERS type T_TEXT_TOKENIZE_PARAMETERS, - end of T_TEXT_TOKENIZE_REQUEST. + "! Verbalizer template to be used for formatting data at train + "! and inference time. This template may use brackets to indicate where fields + "! from the data model TrainGenerationRecord must be rendered. + begin of T_TRAINING_VERBALIZER, + "! The default verbalizer. + DEFAULT type STRING, + end of T_TRAINING_VERBALIZER. types: "!- "! A hardware specification.
- begin of T_HARDWARE_SPEC, - "! The id of the hardware specification. One, and only one, of `id` or `name` must - "! be set. - ID type STRING, - "! The revision of the hardware specification if `id` is used. - REV type STRING, - "! The name of the hardware specification. One, and only one, of `id` or `name` - "! must be set. - NAME type STRING, - "! The number of nodes applied to a computation. - NUM_NODES type INTEGER, - end of T_HARDWARE_SPEC. + "! Maximum length of input tokens being considered. + begin of T_TRAINING_MAX_INPUT_TOKENS, + "! The default value. + DEFAULT type INTEGER, + "! The minimum value. + MIN type INTEGER, + "! The maximum value. + MAX type INTEGER, + end of T_TRAINING_MAX_INPUT_TOKENS. + types: + "!+ "! Maximum length of output tokens being predicted.
+ begin of T_TRAINING_MAX_OUTPUT_TOKENS, + "! The default value. + DEFAULT type INTEGER, + "! The minimum value. + MIN type INTEGER, + "! The maximum value. + MAX type INTEGER, + end of T_TRAINING_MAX_OUTPUT_TOKENS. + types: + "!+ "! Learning rate to be used for training.
+ begin of T_TRAINING_LEARNING_RATE, + "! The default value. + DEFAULT type NUMBER, + "! The minimum value. + MIN type NUMBER, + "! The maximum value. + MAX type NUMBER, + end of T_TRAINING_LEARNING_RATE. + types: + "!+ "! Number of virtual tokens to be used for training. In prompt
+ "! tuning we are essentially learning the embedded representations for soft + "! prompts, which are known as virtual tokens, via back propagation for a specific + "! task(s) while keeping the rest of the model fixed. `num_virtual_tokens` is the + "! number of dimensions for these virtual tokens. + begin of T_TRAINING_NUM_VIRTUAL_TOKENS, + "! The possible values for the number of virtual tokens. + SUPPORTED type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, + "! The default number of virtual tokens. + DEFAULT type INTEGER, + end of T_TRAINING_NUM_VIRTUAL_TOKENS. + types: + "!+ "! Number of steps to be used for gradient accumulation.
+ "! Gradient accumulation refers to a method of collecting gradient for configured + "! number of steps instead of updating the model variables at every step and then + "! applying the update to model variables. This can be used as a tool to overcome + "! smaller batch size limitation. Often also referred in conjunction with + "! "effective batch size". + begin of T_TRAINING_ACCUMULATED_STEPS, + "! The default value. + DEFAULT type INTEGER, + "! The minimum value. + MIN type INTEGER, + "! The maximum value. + MAX type INTEGER, + end of T_TRAINING_ACCUMULATED_STEPS. types: "!- "! Status of the training job.
- begin of T_TRAINING_STATUS_OUTPUT, - "! Status of the training job. - STATUS type T_TRAINING_STATUS, - end of T_TRAINING_STATUS_OUTPUT. + "! Initialization text to be used if init_method is set to + "! `text`, otherwise this will be ignored. + begin of T_TRAINING_INIT_TEXT, + "! Initialization text. + DEFAULT type STRING, + end of T_TRAINING_INIT_TEXT. types: "!- "! The `id` of the model to be used for this request.
- T_GSPTL_TRNSFRMTN_MODEL_ID type String. + "! Training parameters for a given model. + begin of T_TRAINING_PARAMETERS, + "! Initialization methods for a training. + INIT_METHOD type T_TRAINING_INIT_METHOD, + "! Initialization text to be used if init_method is set to `text`, otherwise this + "! will be ignored. + INIT_TEXT type T_TRAINING_INIT_TEXT, + "! Number of virtual tokens to be used for training.- "! The metric for a given property.
- begin of T_AUTO_RAGMETRIC, - "! The mean value calculated over all records in the dataset. - MEAN type NUMBER, - end of T_AUTO_RAGMETRIC. + "! The ratings for this task for this model. + begin of T_TASK_RATING, + "! A metric that indicates the cost expected to be incurred by the model's + "! support of an inference task, in terms of resource consumption and processing + "! time, on a scale of 1 to 5, where 5 is the least cost and 1 is the most cost. A + "! missing value means that the cost is not known. + COST type INTEGER, + "! A metric that indicates the quality of the model's support of an inference + "! task, on a scale of 1 to 5, where 5 is the best support and 1 is poor support. + "! A missing value means that the quality is not known. + QUALITY type INTEGER, + end of T_TASK_RATING. types: "!- "! The return options for text reranking.
- begin of T_RERANK_RETURN_OPTIONS, - "! Just show the top `n` results if set. - TOP_N type INTEGER, - end of T_RERANK_RETURN_OPTIONS. + "! The attributes of the task for this model. + begin of T_TASK_DESCRIPTION, + "! The `id` of the task. + ID type STRING, + "! The ratings for this task for this model. + RATINGS type T_TASK_RATING, + "! The tags for a given task. + TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_TASK_DESCRIPTION. types: "!- "! The tokens that are inferred from the prompt.
- "! The embeddings properties for an AutoRAG pattern.
- begin of T_AUTO_RAGEMBEDDINGS, - "! No documentation available. - STRATEGY type STRING, - "! No documentation available. - SIZE type INTEGER, - "! No documentation available. - MODEL_NAME type STRING, - end of T_AUTO_RAGEMBEDDINGS. + "! Limits per plan that may be set per request. + begin of T_FOUNDATION_MODEL_LIMITS, + "! The limits that may be set per request. + LITE type T_CONSUMPTIONS_LIMIT, + end of T_FOUNDATION_MODEL_LIMITS. types: "!- "! The chunking details for an AutoRAG pattern,.
- begin of T_AUTO_RAGCHUNKING, - "! No documentation available. - METHOD type STRING, - "! No documentation available. - CHUNK_SIZE type INTEGER, - "! No documentation available. - OVERLAP type INTEGER, - end of T_AUTO_RAGCHUNKING. + "! A supported foundation model. + begin of T_FOUNDATION_MODEL, + "! The id of the foundation model. + MODEL_ID type STRING, + "! A short label that will be displayed in the UI. + LABEL type STRING, + "! The provider of the model. + PROVIDER type STRING, + "! The organization or person that tuned this model. + TUNED_BY type STRING, + "! A short description of the model suitable for a title. + SHORT_DESCRIPTION type STRING, + "! A longer description of the model, that may be used if no `description_url` is + "! provided. + LONG_DESCRIPTION type STRING, + "! Limits per plan that may be set per request. + LIMITS type T_FOUNDATION_MODEL_LIMITS, + "! Deprecated: please use `tasks` instead. + TASK_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! The tasks that are supported by this model. + TASKS type STANDARD TABLE OF T_TASK_DESCRIPTION WITH NON-UNIQUE DEFAULT KEY, + "! The tier of the model, depending on the `tier` the billing will be different, + "! refer to the plan for the details. Note that input tokens and output tokens may + "! be charged differently. + INPUT_TIER type STRING, + "! The tier of the model, depending on the `tier` the billing will be different, + "! refer to the plan for the details. Note that input tokens and output tokens may + "! be charged differently. + OUTPUT_TIER type STRING, + "! Specifies the provider of this model. + SOURCE type STRING, + "! The minimum number of examples required for the model. + MIN_SHOT_SIZE type INTEGER, + "! The number of parameters used for the model, it will accept `m` for million, `b` + "! for billion and `t` for trillion. + NUMBER_PARAMS type STRING, + "! The limits that are applied for the model, for all the plans. + MODEL_LIMITS type T_MODEL_LIMITS, + "! The information related to the lifecycle of this model. + LIFECYCLE type STANDARD TABLE OF T_LIFE_CYCLE_STATE WITH NON-UNIQUE DEFAULT KEY, + "! Training parameters for a given model. + TRAINING_PARAMETERS type T_TRAINING_PARAMETERS, + "! The information related to the minor versions of this model. + VERSIONS type STANDARD TABLE OF T_FOUNDATION_MODEL_VERSION WITH NON-UNIQUE DEFAULT KEY, + end of T_FOUNDATION_MODEL. types: "!- "! Properties that describe the AutoRAG vector store that
- "! contains the results. - begin of T_AUTO_RAGVECTOR_STORE, - "! The database name. - DATABASE type STRING, - "! The database index name. - INDEX_NAME type STRING, - "! No documentation available. - DIMENSION type INTEGER, - "! No documentation available. - DISTANCE type STRING, - end of T_AUTO_RAGVECTOR_STORE. + "! The supported foundation models. + T_FOUNDATION_MODELS_ARRAY type STANDARD TABLE OF T_FOUNDATION_MODEL WITH NON-UNIQUE DEFAULT KEY. types: "!- "! Properties describing the AutoRAG generation.
- begin of T_AUTO_RAGGENERATION, - "! No documentation available. - MODEL_NAME type STRING, - "! No documentation available. - MAX_NEW_TOKENS type INTEGER, - "! No documentation available. - PROMPT type STRING, - end of T_AUTO_RAGGENERATION. - types: - "!- "! Properties describing an AutoRAG method.
- begin of T_AUTO_RAGMETHOD, - "! The method name. - METHOD type STRING, - end of T_AUTO_RAGMETHOD. - types: - "!- "! The RAG pattern configuration settings that were found
- "! during the optimization process. - begin of T_AUTO_RAGSETTINGS, - "! Properties that describe the AutoRAG vector store that contains the results. - VECTOR_STORE type T_AUTO_RAGVECTOR_STORE, - "! The chunking details for an AutoRAG pattern,. - CHUNKING type T_AUTO_RAGCHUNKING, - "! The embeddings properties for an AutoRAG pattern. - EMBEDDINGS type T_AUTO_RAGEMBEDDINGS, - "! Properties describing an AutoRAG method. - RETRIEVAL type T_AUTO_RAGMETHOD, - "! Properties describing an AutoRAG method. - RERANKING type T_AUTO_RAGMETHOD, - "! Properties describing the AutoRAG generation. - GENERATION type T_AUTO_RAGGENERATION, - end of T_AUTO_RAGSETTINGS. - types: - "!- "! Describes the elements and settings of found, during the
- "! optimization, of the RAG pattern. - begin of T_AUTO_RAGPATTERN, - "! No documentation available. - COMPOSITION_STEPS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The duration of the optimization step in seconds. - DURATION_SECONDS type INTEGER, - "! The location of the different result files. - LOCATION type T_AUTO_RAGRESULT_LOCATION, - "! The RAG Pattern name. + "! The common fields that can be patched. This is a helper for + "! `cpdctl`. + begin of T_COMMON_PATCH_REQUEST_HELPER, + "! A list of tags for this resource. + TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! The name of the resource. NAME type STRING, - "! The RAG pattern configuration settings that were found during the optimization - "! process. - SETTINGS type T_AUTO_RAGSETTINGS, - end of T_AUTO_RAGPATTERN. - types: - "!- "! The optimization parameters for an AutoRAG job.
- begin of T_AUTO_RAGOPTIMIZATION_PARAM, - "! The metric score used for optimization. - OBJECTIVE_METRIC type STRING, - "! How many of evaluated foundation models should be selected and used in the - "! resutling RAG patterns. - MAX_NUM_FOUNDATION_MODELS type INTEGER, - "! The list of foundation models used to find the best RAG patterns. - INCLUDE_FOUNDATION_MODELS_ONLY type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The list of embedding models used in finding the optimal indexing. - INCLUDE_EMBEDDING_MODELS_ONLY type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_AUTO_RAGOPTIMIZATION_PARAM. - types: - "!- "! The parameters for an AutoRAG job.
- begin of T_AUTO_RAGPARAMETERS, - "! The optimization parameters for an AutoRAG job. - OPTIMIZATION type T_AUTO_RAGOPTIMIZATION_PARAM, - "! Request that the output logs are also stored as part of the result. - OUTPUT_LOGS type BOOLEAN, - end of T_AUTO_RAGPARAMETERS. + "! A description of the resource. + DESCRIPTION type STRING, + "! User defined properties specified as key-value pairs. + CUSTOM type JSONOBJECT, + end of T_COMMON_PATCH_REQUEST_HELPER. types: "! No documentation available. - begin of T_AUTO_RAGCONTEXT, - "! Describes the elements and settings of found, during the optimization, of the - "! RAG pattern. - RAG_PATTERN type T_AUTO_RAGPATTERN, - "! The nodes that make up the AutoRAG pattern. - CHAIN_NODES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The phase of the optimization run in which the particular pattern has been - "! built. - PHASE type STRING, - end of T_AUTO_RAGCONTEXT. - types: - "!- "! The AutoRAG results.
- begin of T_AUTO_RAGRESULTS, - "! The AutoRAG metrics, this contains the list of calculated metrics on test data - "! (provided in the request) and (optionally) synthetic data autogenerated. Metric - "! value is mean value calculated over all records in the dataset. - METRICS type T_AUTO_RAGMETRICS, + begin of T_EXTRNL_PRMPT_ADDTNL_INFRMTN1, "! No documentation available. - CONTEXT type T_AUTO_RAGCONTEXT, - end of T_AUTO_RAGRESULTS. + KEY type STRING, + end of T_EXTRNL_PRMPT_ADDTNL_INFRMTN1. types: "!- "! The AutoRAG results.
- begin of T_AUTO_RAGRESPONSE_ENTITY, - "! A hardware specification. - HARDWARE_SPEC type T_HARDWARE_SPEC, - "! The parameters for an AutoRAG job. - PARAMETERS type T_AUTO_RAGPARAMETERS, - "! A reference to data. - INPUT_DATA_REFERENCES type T_OBJECT_LOCATION, - "! A reference to data. - TEST_DATA_REFERENCES type T_OBJECT_LOCATION, - "! A reference to data. - VECTOR_STORE_REFERENCES type T_OBJECT_LOCATION, - "! The list of results. - RESULTS type STANDARD TABLE OF T_AUTO_RAGRESULTS WITH NON-UNIQUE DEFAULT KEY, - "! The timestamp when the results were created. - TIMESTAMP type DATETIME, - end of T_AUTO_RAGRESPONSE_ENTITY. + "! A deployment resource. + begin of T_DEPLOYMENT_RESOURCE, + "! Common metadata for a resource where `project_id` or `space_id` must be present. + "! + METADATA type T_RESOURCE_META, + "! The definition of the deployment. + ENTITY type T_DEPLOYMENT_ENTITY, + end of T_DEPLOYMENT_RESOURCE. types: "!- "! A text to rank.
- begin of T_RERANK_INPUT, - "! The text to rank. - TEXT type STRING, - end of T_RERANK_INPUT. + "! The deployment resources. + begin of T_DPLYMNT_RESOURCE_COLLECTION, + "! The total number of resources. Computed explicitly only when + "! 'total_count=true' query parameter is present. This is in order to + "! avoid performance penalties. + TOTAL_COUNT type INTEGER, + "! The number of items to return in each page. + LIMIT type INTEGER, + "! The reference to the first item in the current page. + FIRST type T_PAGINATION_FIRST, + "! A reference to the first item of the next page, if any. + NEXT type T_PAGINATION_NEXT, + "! A list of deployment resources. + RESOURCES type STANDARD TABLE OF T_DEPLOYMENT_RESOURCE WITH NON-UNIQUE DEFAULT KEY, + "! System details including warnings. + SYSTEM type T_DEPLOYMENT_SYSTEM, + end of T_DPLYMNT_RESOURCE_COLLECTION. types: "!- "! The AutoRAG metadata fields.
- begin of T_AUTO_RAGMETADATA, - "! The id of the resource. - ID type STRING, - "! The time when the resource was created. - CREATED_AT type DATETIME, - "! The name of the AutoRAG job. - NAME type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - end of T_AUTO_RAGMETADATA. + "! Represents the maximum number of input tokens accepted. This + "! can be used to avoid requests failing due to input being longer than configured + "! limits. If the text is truncated, then it truncates the start of the input (on + "! the left), so the end of the input will remain the same. If this value exceeds + "! the `maximum sequence length` (refer to the documentation to find this value + "! for the model) then the call will fail if the total number of tokens exceeds + "! the `maximum sequence length`. Zero means don't truncate. + T_PRM_TRNCT_INPT_TKNS_FRM_STRT type Integer. + types: + "!+ "! A task that is covered by some of the foundation models that
+ "! are supported in the service. + begin of T_FOUNDATION_MODEL_TASK, + "! The id of the task. + TASK_ID type STRING, + "! The label of the task. + LABEL type STRING, + "! The description of the task. + DESCRIPTION type STRING, + "! The rank of the task that is mainly for the UI. + RANK type INTEGER, + end of T_FOUNDATION_MODEL_TASK. + types: + "!+ "! System details.
+ begin of T_FOUNDATION_MODEL_TASKS, + "! The total number of resources. + TOTAL_COUNT type INTEGER, + "! The number of items to return in each page. + LIMIT type INTEGER, + "! The reference to the first item in the current page. + FIRST type T_PAGINATION_FIRST, + "! A reference to the first item of the next page, if any. + NEXT type T_PAGINATION_NEXT, + "! The supported foundation model tasks. + RESOURCES type STANDARD TABLE OF T_FOUNDATION_MODEL_TASK WITH NON-UNIQUE DEFAULT KEY, + "! Optional details coming from the service and related to the API call or the + "! associated resource. + SYSTEM type T_SYSTEM_DETAILS, + end of T_FOUNDATION_MODEL_TASKS. + types: + "! No documentation available. + begin of T_WX_PROMPT_RESP_MODEL_VERSION, + "! User provided semvar version for tracking in IBM AI Factsheets. + NUMBER type STRING, + "! User provived tag. + TAG type STRING, + "! Description of the version. + DESCRIPTION type STRING, + end of T_WX_PROMPT_RESP_MODEL_VERSION. types: "!- "! The response of an AutoRAG job.
- begin of T_AUTO_RAGRESPONSE, - "! The AutoRAG metadata fields. - METADATA type T_AUTO_RAGMETADATA, - "! The AutoRAG results. - ENTITY type T_AUTO_RAGRESPONSE_ENTITY, - end of T_AUTO_RAGRESPONSE. + "! A list of notebook versions in a project. + begin of T_NTBK_VRSNS_LST_RESP_NTBK_VR1, + "! The number of items in the resources array. + TOTAL_RESULTS type INTEGER, + "! An array of notebook versions. + RESOURCES type STANDARD TABLE OF T_NOTEBOOK_VERSION_IN_PROJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_NTBK_VRSNS_LST_RESP_NTBK_VR1. types: "!- "! The AutoRAG results.
- begin of T_AUTO_RAGRESPONSE_RESULTS, - "! The list of results. - RESULTS type STANDARD TABLE OF T_AUTO_RAGRESULTS WITH NON-UNIQUE DEFAULT KEY, - "! The timestamp when the results were created. - TIMESTAMP type DATETIME, - end of T_AUTO_RAGRESPONSE_RESULTS. + "! Optional details coming from the service and related to the + "! API call or the associated resource. + begin of T_TRAIN_RSRC_COLLECTION_SYS, + "! Any warnings coming from the system. + WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, + end of T_TRAIN_RSRC_COLLECTION_SYS. types: "!- "! The request fields that are not part of the returned entity.
- begin of T_AUTO_RAGREQUEST_FIELDS, - "! The name of the AutoRAG job. - NAME type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - end of T_AUTO_RAGREQUEST_FIELDS. + "! Status of the training job. + begin of T_TRAINING_RESOURCE_ENTITY, + "! Properties to control the prompt tuning. + PROMPT_TUNING type T_PROMPT_TUNING, + "! Training datasets. + TRAINING_DATA_REFERENCES type STANDARD TABLE OF T_DATA_CONNECTION_REFERENCE WITH NON-UNIQUE DEFAULT KEY, + "! User defined properties specified as key-value pairs. + CUSTOM type JSONOBJECT, + "! If set to `true` then the result of the training, if successful, will be + "! uploaded to the repository as a model. + AUTO_UPDATE_MODEL type BOOLEAN, + "! The training results. Normally this is specified as `type=container` which means + "! that it is stored in the space or project. Note that the training will add some + "! fields that point to the training status, the model request and the + "! assets.- "! Properties that control what is returned.
- begin of T_RETURN_OPTION_PROPERTIES, - "! Include input text in the `generated_text` field. - INPUT_TEXT type BOOLEAN, - "! Include the list of individual generated tokens. Extra token information is - "! included based on the other flags below. - GENERATED_TOKENS type BOOLEAN, - "! Include the list of input tokens. Extra token information is included based on - "! the other flags here, but only for decoder-only models. - INPUT_TOKENS type BOOLEAN, - "! Include logprob (natural log of probability) for each returned token. Applicable - "! only if generated_tokens == true and/or input_tokens == true. - TOKEN_LOGPROBS type BOOLEAN, - "! Include rank of each returned token. Applicable only if generated_tokens == true - "! and/or input_tokens == true. - TOKEN_RANKS type BOOLEAN, - "! Include top n candidate tokens at the position of each returned token. The - "! maximum value permitted is 5, but more may be returned if there is a tie for - "! nth place. Applicable only if generated_tokens == true and/or input_tokens == - "! true. - TOP_N_TOKENS type INTEGER, - end of T_RETURN_OPTION_PROPERTIES. + "! Training resource. + begin of T_TRAINING_RESOURCE, + "! Common metadata for a resource where `project_id` or `space_id` must be present. + "! + METADATA type T_RESOURCE_META, + "! Status of the training job. + ENTITY type T_TRAINING_RESOURCE_ENTITY, + end of T_TRAINING_RESOURCE. types: "!- "! The properties specific to HAP.
- begin of T_MODERATION_HAP_PROPERTIES, - "! Properties that control the moderation on the text. - INPUT type T_TEXT_MODERATION, - "! Properties that control the moderation on the text. - OUTPUT type T_TEXT_MODERATION, - "! The properties specific to masking. If this object exists,"! The properties specific to PII.
- begin of T_MODERATION_PII_PROPERTIES, - "! Properties that control the moderation on the text. - INPUT type T_TEXT_MODERATION, - "! Properties that control the moderation on the text. - OUTPUT type T_TEXT_MODERATION, + begin of T_PII_PROPERTIES, "! The properties specific to masking. If this object exists,- "! Properties that control the moderations, for usages such as
- "! `Hate and profanity` (HAP) and `Personal identifiable information` (PII) - "! filtering. This list can be extended with new types of moderations. - begin of T_MODERATIONS, - "! The properties specific to HAP. - HAP type T_MODERATION_HAP_PROPERTIES, - "! The properties specific to PII. - PII type T_MODERATION_PII_PROPERTIES, - "! If set, then only these ranges will be applied to the moderations. This is - "! useful in the case that certain parts of the input text have already been - "! checked. - INPUT_RANGES type STANDARD TABLE OF T_MODERATION_TEXT_RANGE WITH NON-UNIQUE DEFAULT KEY, - end of T_MODERATIONS. - types: - "!- "! It can be used to exponentially increase the likelihood of
- "! the text generation terminating once a specified number of tokens have been - "! generated. - begin of T_TEXT_GEN_LENGTH_PENALTY, - "! Represents the factor of exponential decay. Larger values correspond to more - "! aggressive decay. - DECAY_FACTOR type NUMBER, - "! A number of generated tokens after which this should take effect. - START_INDEX type INTEGER, - end of T_TEXT_GEN_LENGTH_PENALTY. + end of T_PII_PROPERTIES. types: "!- "! The template properties if this request refers to a prompt
- "! template. - begin of T_DPLYMNT_TEXT_GEN_PROPERTIES, - "! Represents the strategy used for picking the tokens during generation of the - "! output text.- "! The space that contains the resource.
- T_SPACE_ID_ONLY type String. + "! A notebook version in a project. + begin of T_NTBK_VER_RTRV_RESP_NTBK_VER1, + "! Notebook version metadata. + METADATA type T_NOTEBOOK_VERSION_METADATA, + "! A notebook version entity in a project. + ENTITY type T_NTBK_VER_ENTITY_IN_PROJECT, + end of T_NTBK_VER_RTRV_RESP_NTBK_VER1. types: "!- "! The embedding values for a text string. The `input` field is
- "! only set if the corresponding `return_option` is set. - begin of T_EMBEDDING, - "! The text input to the model. - INPUT type STRING, - "! The embedding values. - EMBEDDING type STANDARD TABLE OF NUMBER WITH NON-UNIQUE DEFAULT KEY, - end of T_EMBEDDING. + "! The supported foundation model tasks. + T_FOUNDATION_MODEL_TASKS_ARRAY type STANDARD TABLE OF T_FOUNDATION_MODEL_TASK WITH NON-UNIQUE DEFAULT KEY. types: "!- "! The embeddings per input.
- begin of T_EMBEDDINGS_RESPONSE_FIELDS, - "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). - MODEL_ID type STRING, - "! The embedding values for a given text. - RESULTS type STANDARD TABLE OF T_EMBEDDING WITH NON-UNIQUE DEFAULT KEY, - "! The time when the response was created. - CREATED_AT type DATETIME, - "! The number of input tokens that were consumed. - INPUT_TOKEN_COUNT type INTEGER, - end of T_EMBEDDINGS_RESPONSE_FIELDS. + "! Common metadata for a resource. + begin of T_RESOURCE_META_BASE, + "! The revision of the resource. + REV type STRING, + "! The user id which created this resource. + OWNER type STRING, + "! The time when the resource was last modified. + MODIFIED_AT type DATETIME, + "! The id of the parent resource where applicable. + PARENT_ID type STRING, + "! The name of the resource. + NAME type STRING, + "! A description of the resource. + DESCRIPTION type STRING, + "! A list of tags for this resource. + TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! Information related to the revision. + COMMIT_INFO type T_RESOURCE_COMMIT_INFO, + end of T_RESOURCE_META_BASE. types: "!- "! A data location of the input or output data.
- begin of T_GSPTL_TRANSFORMATION_DATA, - "! A signed url for the data in COS or elsewhere. This url will be used to download - "! if this is input, or upload if this is output. - URL type STRING, - end of T_GSPTL_TRANSFORMATION_DATA. + "! Asset API asset description returned with a notebook + "! listing. + begin of T_NTBK_RESOURCE_ENTITY_ASSET, + "! The UUID of the asset. + ASSET_ID type STRING, + "! The asset type. Always "notebook". + ASSET_TYPE type STRING, + "! Timestamp of the creation date, ms since epoch. + CREATED type INTEGER, + "! Date the asset was created, ISO format. + CREATED_AT type STRING, + "! The asset catalog ID. + CATALOG_ID type STRING, + "! The project the notebook belongs to. + PROJECT_ID type STRING, + "! Version of the asset. + VERSION type INTEGER, + "! The asset URL. + HREF type STRING, + end of T_NTBK_RESOURCE_ENTITY_ASSET. types: - "!- "! The transformation results.
- begin of T_GSPTL_TRANSFORMATION_RESULTS, - "! The status of the transformation. - STATUS type STRING, - end of T_GSPTL_TRANSFORMATION_RESULTS. + "! No documentation available. + T_EXTRNL_PRMPT_ADDTNL_INFRMTN type STANDARD TABLE OF T_EXTRNL_PRMPT_ADDTNL_INFRMTN1 WITH NON-UNIQUE DEFAULT KEY. types: - "!- "! The transformation results.
- begin of T_GSPTL_TRNSFRMTN_RESP_ENTITY, - "! The `id` of the model to be used for this request. - MODEL_ID type STRING, - "! The input text. - INPUTS type STANDARD TABLE OF T_GSPTL_TRANSFORMATION_DATA WITH NON-UNIQUE DEFAULT KEY, - "! A data location of the input or output data. - OUTPUT type T_GSPTL_TRANSFORMATION_DATA, - "! The transformation results. - RESULTS type T_GSPTL_TRANSFORMATION_RESULTS, - end of T_GSPTL_TRNSFRMTN_RESP_ENTITY. + "! No documentation available. + begin of T_WX_PROMPT_PATCH_MODEL_VER, + "! User provided semvar version for tracking in IBM AI Factsheets. + NUMBER type STRING, + "! User provived tag. + TAG type STRING, + "! Description of the version. + DESCRIPTION type STRING, + end of T_WX_PROMPT_PATCH_MODEL_VER. types: "!- "! A reference to a resource.
- begin of T_SIMPLE_REL, - "! The id of the referenced resource. - ID type STRING, - end of T_SIMPLE_REL. + "! The properties for the moderation. Each type of moderation + "! may have additional properties that are specific to that moderation. + begin of T_MODERATION_PROPERTIES, + "! Properties that control the moderation on the text. + INPUT type T_TEXT_MODERATION, + "! Properties that control the moderation on the text. + OUTPUT type T_TEXT_MODERATION, + end of T_MODERATION_PROPERTIES. types: "!- "! The number of input tokens that were consumed.
- T_INPUT_TOKEN_COUNT type Integer. + "! Status of the training job. + begin of T_TRAINING_STATUS_OUTPUT, + "! Status of the training job. + STATUS type T_TRAINING_STATUS, + end of T_TRAINING_STATUS_OUTPUT. types: "!- "! The return options for text embeddings.
- begin of T_EMBEDDING_RETURN_OPTIONS, - "! Include the `input` text in each of the `results` documents. - INPUT_TEXT type BOOLEAN, - end of T_EMBEDDING_RETURN_OPTIONS. + "! Entity of notebook info returned in a listing. + begin of T_NOTEBOOK_RESOURCE_ENTITY, + "! Asset API asset description returned with a notebook listing. + ASSET type T_NTBK_RESOURCE_ENTITY_ASSET, + "! Runtime info returned with a notebook listing. + RUNTIME type T_NOTEBOOK_RESOURCE_ENTITY_RT, + end of T_NOTEBOOK_RESOURCE_ENTITY. types: "!- "! Parameters for text embedding requests.
- begin of T_EMBEDDING_PARAMETERS, - "! Fail the call if the number of input tokens exceeds the allowed value. This - "! value can not be greater than the maximum sequence length that the model - "! supports. - TRUNCATE_INPUT_TOKENS type INTEGER, - "! The return options for text embeddings. - RETURN_OPTIONS type T_EMBEDDING_RETURN_OPTIONS, - end of T_EMBEDDING_PARAMETERS. + "! System details. + begin of T_SYSTEM, + "! Optional details coming from the service and related to the API call or the + "! associated resource. + SYSTEM type T_SYSTEM_DETAILS, + end of T_SYSTEM. types: "!- "! Metrics that can be returned by an operation.
- T_TRAINING_METRICS type STANDARD TABLE OF T_TRAINING_METRIC WITH NON-UNIQUE DEFAULT KEY. + "! Represents the maximum number of input tokens accepted. This + "! can be used to avoid requests failing due to input being longer than configured + "! limits. If the text is truncated, then it truncates the end of the input (on + "! the right), so the start of the input will remain the same. If this value + "! exceeds the `maximum sequence length` (refer to the documentation to find this + "! value for the model) then the call will fail if the total number of tokens + "! exceeds the `maximum sequence length`. Zero means don't truncate. + T_PRM_TRNCT_INPT_TKNS_FROM_END type Integer. types: - "!- "! The request entity for an AutoRAG job.
- begin of T_AUTO_RAGREQUEST_ENTITY, - "! A hardware specification. - HARDWARE_SPEC type T_HARDWARE_SPEC, - "! The parameters for an AutoRAG job. - PARAMETERS type T_AUTO_RAGPARAMETERS, - "! A reference to data. - INPUT_DATA_REFERENCES type T_OBJECT_LOCATION, - "! A reference to data. - TEST_DATA_REFERENCES type T_OBJECT_LOCATION, - "! A reference to data. - VECTOR_STORE_REFERENCES type T_OBJECT_LOCATION, - end of T_AUTO_RAGREQUEST_ENTITY. + "! No documentation available. + T_NOTEBOOK_VER_CREATE_RESPONSE type JSONOBJECT. types: "!- "! Contains a set of fields that describe the location of the
- "! data with respect to the `connection`. - T_DATA_LOCATION type MAP. + "! Definition part of a notebook entity copied from a source. + begin of T_NOTEBOOK_ENTITY_DEF_FOR_COPY, + "! A notebook kernel. + KERNEL type T_NOTEBOOK_KERNEL, + "! The origin of a notebook from a source. + ORIGINATES_FROM type T_NOTEBOOK_ORIGIN_FROM_SOURCE, + end of T_NOTEBOOK_ENTITY_DEF_FOR_COPY. types: "!- "! The specific fields for the geospatial transformation
- "! metadata fields. - begin of T_GSPTL_TRNSFRMTN_METADATA, - "! The id of the resource. - ID type STRING, - "! The time when the resource was created. - CREATED_AT type DATETIME, - "! The space that contains the resource. - SPACE_ID type STRING, - end of T_GSPTL_TRNSFRMTN_METADATA. + "! Notebook info returned in a listing. + begin of T_NOTEBOOK_RESOURCE, + "! Metadata of notebook info returned in a listing. + METADATA type T_NOTEBOOK_RESOURCE_METADATA, + "! Entity of notebook info returned in a listing. + ENTITY type T_NOTEBOOK_RESOURCE_ENTITY, + end of T_NOTEBOOK_RESOURCE. types: "!- "! A reference to a resource.
- begin of T_REL, - "! The id of the referenced resource. - ID type STRING, - "! The revision of the referenced resource. - REV type STRING, - end of T_REL. + "! The number of input tokens that were consumed. + T_INPUT_TOKEN_COUNT type Integer. types: "!- "! A set of key-value pairs that are used to configure the
- "! deployment. - begin of T_ONLINE_DEPLOYMENT_PARAMETERS, - "! The `serving_name` can be used in the inference URL in place of the - "! `deployment_id`. - SERVING_NAME type STRING, - end of T_ONLINE_DEPLOYMENT_PARAMETERS. + "! The properties for the moderation. Each type of moderation + "! may have additional properties that are specific to that moderation. + begin of T_MODERATION_INPUT_PROPERTIES, + "! Properties that control the moderation on the text. + INPUT type T_TEXT_MODERATION, + end of T_MODERATION_INPUT_PROPERTIES. types: "!- "! Indicates that this is an online deployment. An object has
- "! to be specified but can be empty. The `serving_name` can be provided in the - "! `online.parameters`. - begin of T_ONLINE_DEPLOYMENT, - "! A set of key-value pairs that are used to configure the deployment. - PARAMETERS type T_ONLINE_DEPLOYMENT_PARAMETERS, - end of T_ONLINE_DEPLOYMENT. + "! Notebook information in a project as returned by a GET + "! request. + begin of T_NTBK_RVRT_RESP_NTBK_IN_PRJCT, + "! Metadata of a notebook in a project. + METADATA type T_NOTEBOOK_METADATA_IN_PROJECT, + "! Entity of a notebook. + ENTITY type T_NOTEBOOK_ENTITY, + end of T_NTBK_RVRT_RESP_NTBK_IN_PRJCT. types: "!- "! The deployment request entity (this description is not
- "! used). - begin of T_DPLYMNT_RESOURCE_PROTOTYPE, - "! The name of the resource. - NAME type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - "! A description of the resource. - DESCRIPTION type STRING, - "! A list of tags for this resource. - TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! User defined properties specified as key-value pairs. - CUSTOM type JSONOBJECT, - "! A reference to a resource. - ASSET type T_REL, - "! A reference to a resource. - PROMPT_TEMPLATE type T_SIMPLE_REL, - "! Indicates that this is an online deployment. An object has to be specified but - "! can be empty."! System details.
begin of T_EMBEDDINGS_RESPONSE, "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). MODEL_ID type STRING, "! The embedding values for a given text. RESULTS type STANDARD TABLE OF T_EMBEDDING WITH NON-UNIQUE DEFAULT KEY, @@ -1686,38 +2232,15 @@ public section. INPUT_TOKEN_COUNT type INTEGER, "! Optional details coming from the service and related to the API call or the "! associated resource. - SYSTEM type T_SYSTEM_TG_DETAILS, + SYSTEM type T_SYSTEM_DETAILS, end of T_EMBEDDINGS_RESPONSE. - types: - "!- "! The inputs and outputs required to create a transformation
- "! for the given model. - begin of T_GSPTL_TRANSFORMATION_ENTITY, - "! The `id` of the model to be used for this request. - MODEL_ID type STRING, - "! The input text. - INPUTS type STANDARD TABLE OF T_GSPTL_TRANSFORMATION_DATA WITH NON-UNIQUE DEFAULT KEY, - "! A data location of the input or output data. - OUTPUT type T_GSPTL_TRANSFORMATION_DATA, - end of T_GSPTL_TRANSFORMATION_ENTITY. types: "!"! A set of server sent events, each event contains a response
- "! for one or more tokens. + "! for one or more tokens. The results will be an array of events of the form + "! `data: {<json event>}` where the schema of the individual `json + "! event` is described below. T_TEXT_GEN_STREAM_RESPONSE type STANDARD TABLE OF T_TEXT_GEN_RESPONSE WITH NON-UNIQUE DEFAULT KEY. - types: - "!- "! The AutoRAG metadata fields.
- begin of T_AUTO_RAGMETADATA_FIELDS, - "! The name of the AutoRAG job. - NAME type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - end of T_AUTO_RAGMETADATA_FIELDS. types: "!"! The template properties if this request refers to a prompt
@@ -1726,43 +2249,75 @@ public section. "! The prompt variables. PROMPT_VARIABLES type MAP, end of T_PROMPT_TEMPLATE_VARIABLES. + types: + "! No documentation available. + begin of T_WX_PROMPT_SESSION_ENTRY, + "! The prompt's id. This value cannot be set. It is returned in responses + "! only. + ID type STRING, + "! Name used to display the prompt. + NAME type STRING, + "! An optional description for the prompt. + DESCRIPTION type STRING, + "! No documentation available. + PROMPT_VARIABLES type MAP, + "! No documentation available. + IS_TEMPLATE type BOOLEAN, + "! Time the prompt was created. + CREATED_AT type INTEGER, + "! Input mode in use for the prompt. + INPUT_MODE type STRING, + "! No documentation available. + PROMPT type T_PROMPT, + end of T_WX_PROMPT_SESSION_ENTRY. + types: + "! No documentation available. + begin of T_WX_PROMPT_SESSION, + "! The prompt session's id. This value cannot be set. It is returned in + "! responses only. + ID type STRING, + "! Name used to display the prompt session. + NAME type STRING, + "! An optional description for the prompt session. + DESCRIPTION type STRING, + "! Time the session was created. + CREATED_AT type INTEGER, + "! The ID of the original session creator. + CREATED_BY type STRING, + "! Time the session was updated. + LAST_UPDATED_AT type INTEGER, + "! The ID of the last user that modifed the session. + LAST_UPDATED_BY type STRING, + "! No documentation available. + LOCK type T_PROMPT_LOCK, + "! No documentation available. + PROMPTS type STANDARD TABLE OF T_WX_PROMPT_SESSION_ENTRY WITH NON-UNIQUE DEFAULT KEY, + end of T_WX_PROMPT_SESSION. types: "!- "! Optional details coming from the service and related to the
- "! API call or the associated resource. - begin of T_SYSTEM_DETAILS, - "! Any warnings coming from the system. - WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, - end of T_SYSTEM_DETAILS. + "! Entity of a notebook copied from a source. + begin of T_NOTEBOOK_ENTITY_FOR_COPY, + "! Definition part of a notebook entity copied from a source. + NOTEBOOK type T_NOTEBOOK_ENTITY_DEF_FOR_COPY, + "! A notebook runtime. + RUNTIME type T_NOTEBOOK_RUNTIME, + "! Full URI of the notebook. + HREF type STRING, + end of T_NOTEBOOK_ENTITY_FOR_COPY. types: "!- "! Information for paging when querying resources.
- begin of T_PAGINATION, - "! The total number of resources. Computed explicitly only when - "! 'total_count=true' query parameter is present. This is in order to - "! avoid performance penalties. - TOTAL_COUNT type INTEGER, - "! The number of items to return in each page. - LIMIT type INTEGER, - "! The reference to the first item in the current page. - FIRST type T_PAGINATION_FIRST, - "! A reference to the first item of the next page, if any. - NEXT type T_PAGINATION_NEXT, - end of T_PAGINATION. + "! Information of a copied notebook as returned by a GET + "! request. + begin of T_NTBK_CRE_RESP_NTBK_FOR_COPY, + "! Metadata of a notebook in a project. + METADATA type T_NOTEBOOK_METADATA_IN_PROJECT, + "! Entity of a notebook copied from a source. + ENTITY type T_NOTEBOOK_ENTITY_FOR_COPY, + end of T_NTBK_CRE_RESP_NTBK_FOR_COPY. types: "!"! A prompt to be used to infer the next tokens.
- begin of T_DEPLOYMENT_TEXT_GEN_REQUEST, - "! The prompt to generate completions. Note: The method tokenizes the input - "! internally. It is recommended not to leave any trailing spaces. - INPUT type STRING, - "! The template properties if this request refers to a prompt template. - PARAMETERS type T_DPLYMNT_TEXT_GEN_PROPERTIES, - "! Properties that control the moderations, for usages such as `Hate and profanity` - "! (HAP) and `Personal identifiable information` (PII) filtering. This list can be - "! extended with new types of moderations. - MODERATIONS type T_MODERATIONS, - end of T_DEPLOYMENT_TEXT_GEN_REQUEST. + T_DEPLOYMENT_TEXT_GEN_REQUEST type T_DEPLOYMENT_TEXT_GEN. types: "!"! Properties that control the model and response that are only
@@ -1831,9 +2386,13 @@ public section. "! Represents the penalty for penalizing tokens that have already been generated or "! belong to the context. The value 1.0 means that there is no penalty. REPETITION_PENALTY type NUMBER, - "! Represents the number to which input tokens would be truncated. Can be used to - "! avoid requests failing due to input being longer than configured limits. Zero - "! means don't truncate. + "! Represents the maximum number of input tokens accepted. This can be used to + "! avoid requests failing due to input being longer than configured limits. If the + "! text is truncated, then it truncates the start of the input (on the left), so + "! the end of the input will remain the same. If this value exceeds the `maximum + "! sequence length` (refer to the documentation to find this value for the model) + "! then the call will fail if the total number of tokens exceeds the `maximum + "! sequence length`. Zero means don't truncate. TRUNCATE_INPUT_TOKENS type INTEGER, "! Properties that control what is returned. RETURN_OPTIONS type T_RETURN_OPTION_PROPERTIES, @@ -1848,14 +2407,6 @@ public section. "! up to typical_p or higher are kept for generation. TYPICAL_P type NUMBER, end of T_TEXT_GEN_PARAMETERS2. - types: - "! No documentation available. - begin of T_RESULTS_REFERENCE_INPUT, - "! The training results. Normally this is specified as `type=container` which - "! means"! The properties that are part of a request that supports
@@ -1875,53 +2426,6 @@ public section. "! A list of tags for this resource. TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_ENTITY_REQ_SPC_PROJECT_BODY. - types: - "!- "! System details.
- begin of T_SYSTEM_TG, - "! Optional details coming from the service and related to the API call or the - "! associated resource. - SYSTEM type T_SYSTEM_TG_DETAILS, - end of T_SYSTEM_TG. - types: - "!- "! The properties used for reranking.
- begin of T_RERANK_PARAMETERS, - "! Fail the call if the number of input tokens exceeds the allowed value. This - "! value can not be greater than the maximum sequence length that the model - "! supports. - TRUNCATE_INPUT_TOKENS type INTEGER, - "! The return options for text reranking. - RETURN_OPTIONS type T_RERANK_RETURN_OPTIONS, - end of T_RERANK_PARAMETERS. - types: - "!- "! The details of an inference API.
- begin of T_INFERENCE, - "! The inference URL. - URL type STRING, - "! This is `true` if the inference API supports SSE streaming. - SSE type BOOLEAN, - "! This is `true` if the inference API uses the `serving_name` that was defined in - "! this deployment. - USES_SERVING_NAME type BOOLEAN, - end of T_INFERENCE. - types: - "!- "! Specifies the current status, additional information about
- "! the deployment and any failure messages in case of deployment failures. - begin of T_DEPLOYMENT_STATUS, - "! Specifies the current state of the deployment. - STATE type STRING, - "! Optional messages related to the deployment. - MESSAGE type T_MESSAGE, - "! The data returned when an error is encountered. - FAILURE type T_ERROR, - "! The URLs that can be used to submit inference API requests. These URLs will - "! contain the"! A prompt to be used to infer the next tokens. Each request
@@ -1933,14 +2437,6 @@ public section. "! internally. It is recommended not to leave any trailing spaces. INPUT type STRING, end of T_TEXT_GEN_COMMON. - types: - "!- "! The specific fields for the geospatial transformation
- "! metadata fields. - begin of T_GSPTL_TRNSFRMTN_MTDT_FIELDS, - "! The space that contains the resource. - SPACE_ID type STRING, - end of T_GSPTL_TRNSFRMTN_MTDT_FIELDS. types: "!"! Properties that control the model and response.
@@ -2008,9 +2504,13 @@ public section. "! Represents the penalty for penalizing tokens that have already been generated or "! belong to the context. The value 1.0 means that there is no penalty. REPETITION_PENALTY type NUMBER, - "! Represents the number to which input tokens would be truncated. Can be used to - "! avoid requests failing due to input being longer than configured limits. Zero - "! means don't truncate. + "! Represents the maximum number of input tokens accepted. This can be used to + "! avoid requests failing due to input being longer than configured limits. If the + "! text is truncated, then it truncates the start of the input (on the left), so + "! the end of the input will remain the same. If this value exceeds the `maximum + "! sequence length` (refer to the documentation to find this value for the model) + "! then the call will fail if the total number of tokens exceeds the `maximum + "! sequence length`. Zero means don't truncate. TRUNCATE_INPUT_TOKENS type INTEGER, "! Properties that control what is returned. RETURN_OPTIONS type T_RETURN_OPTION_PROPERTIES, @@ -2021,47 +2521,36 @@ public section. end of T_TEXT_GEN_PARAMETERS. types: "!- "! This model represents an individual patch operation to be
- "! performed on a JSON document, as defined by RFC 6902. - begin of T_JSON_PATCH_OPERATION, - "! The operation to be performed. - OP type STRING, - "! The JSON Pointer that identifies the field that is the target of the operation. - PATH type STRING, - "! The JSON Pointer that identifies the field that is the source of the operation. - FROM type STRING, - "! The value to be used within the operation. - VALUE type JSONOBJECT, - end of T_JSON_PATCH_OPERATION. - types: - "! No documentation available. - begin of T_PAGINATION_BASE, - "! Computed explicitly only when 'total_count=true' query parameter is - "! present. This is in order to avoid performance penalties. - TOTAL_COUNT type INTEGER, - "! The number of items to return in each page. - LIMIT type INTEGER, - "! The reference to the first item in the current page. - FIRST type T_PAGINATION_FIRST, - "! A reference to the first item of the next page, if any. - NEXT type T_PAGINATION_NEXT, - end of T_PAGINATION_BASE. - types: - "!- "! User defined properties specified as key-value pairs.
- T_CUSTOM type JSONOBJECT. + "! A list of notebook versions in a project. + begin of T_NTBK_VERSIONS_LST_IN_PROJECT, + "! The number of items in the resources array. + TOTAL_RESULTS type INTEGER, + "! An array of notebook versions. + RESOURCES type STANDARD TABLE OF T_NOTEBOOK_VERSION_IN_PROJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_NTBK_VERSIONS_LST_IN_PROJECT. types: "!- "! The `id` of the model to be used for this request. Please
- "! refer to the [list of models](TBD). - T_EMBEDDING_MODEL_ID type String. + "! This model represents an individual patch operation to be + "! performed on a JSON document, as defined by RFC 6902. + begin of T_JSON_PATCH_OPERATION, + "! The operation to be performed. + OP type STRING, + "! The JSON Pointer that identifies the field that is the target of the operation. + PATH type STRING, + "! The JSON Pointer that identifies the field that is the source of the operation. + FROM type STRING, + "! The value to be used within the operation. + VALUE type JSONOBJECT, + end of T_JSON_PATCH_OPERATION. types: "!- "! The similarity results.
- begin of T_SIMILARITY_RESULT, - "! A similarity score between the source and target text. - SCORE type NUMBER, - end of T_SIMILARITY_RESULT. + "! An error response. + begin of T_ERROR_RESPONSE, + "! The trace ID used in logs. + TRACE type STRING, + "! The error objects. + ERRORS type STANDARD TABLE OF T_ERROR WITH NON-UNIQUE DEFAULT KEY, + end of T_ERROR_RESPONSE. types: "!"! The common fields between a request and the response.
@@ -2079,40 +2568,13 @@ public section. "! A hardware specification. HARDWARE_SPEC type T_HARDWARE_SPEC, end of T_DEPLOYMENT_ENTITY_COMMON. - types: - "!- "! The text input for a given model to be used to generate the
- "! embeddings. - begin of T_EMBEDDINGS_REQUEST, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). - MODEL_ID type STRING, - "! The input text. - INPUTS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Parameters for text embedding requests. - PARAMETERS type T_EMBEDDING_PARAMETERS, - end of T_EMBEDDINGS_REQUEST. - types: - "!- "! The ranking score for the input.
- begin of T_RERANKED_RESULTS, - "! A text to rank. - INPUT type T_RERANK_INPUT, - "! The score of the input. - SCORE type NUMBER, - end of T_RERANKED_RESULTS. types: "!"! System details.
begin of T_RERANK_RESPONSE, "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). MODEL_ID type STRING, "! The rank query. QUERY type STRING, @@ -2124,28 +2586,41 @@ public section. INPUT_TOKEN_COUNT type INTEGER, "! Optional details coming from the service and related to the API call or the "! associated resource. - SYSTEM type T_SYSTEM_TG_DETAILS, + SYSTEM type T_SYSTEM_DETAILS, end of T_RERANK_RESPONSE. types: "!- "! The request to rerank texts.
- begin of T_RERANK_REQUEST, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). - MODEL_ID type STRING, - "! The rank input strings. - INPUTS type STANDARD TABLE OF T_RERANK_INPUT WITH NON-UNIQUE DEFAULT KEY, - "! The rank query. - QUERY type STRING, - "! The properties used for reranking. - PARAMETERS type T_RERANK_PARAMETERS, - end of T_RERANK_REQUEST. + "! Payload for a notebook update request. + begin of T_NOTEBOOK_UPDATE_BODY, + "! The guid of the environment on which the notebook runs. + ENVIRONMENT type STRING, + "! Spark monitoring enabled or not. + SPARK_MONITORING_ENABLED type BOOLEAN, + "! A notebook kernel. + KERNEL type T_NOTEBOOK_KERNEL, + end of T_NOTEBOOK_UPDATE_BODY. + types: + "! No documentation available. + begin of T_WX_PROMPT_POST, + "! Name used to display the prompt. + NAME type STRING, + "! An optional description for the prompt. + DESCRIPTION type STRING, + "! Time the prompt was created. + CREATED_AT type INTEGER, + "! No documentation available. + TASK_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. + LOCK type T_PROMPT_LOCK, + "! No documentation available. + MODEL_VERSION type T_WX_PROMPT_POST_MODEL_VERSION, + "! No documentation available. + PROMPT_VARIABLES type MAP, + "! Input mode in use for the prompt. + INPUT_MODE type STRING, + "! No documentation available. + PROMPT type T_PROMPT_WITH_EXTERNAL, + end of T_WX_PROMPT_POST. types: "!"! The result of tokenizing the input string.
@@ -2166,14 +2641,6 @@ public section. "! The result of tokenizing the input string. RESULT type T_TEXT_TOKENIZE_RESULT, end of T_TEXT_TOKENIZE_RESPONSE. - types: - "!- "! The properties specific to `watsonx.ai` deployments.
- begin of T_DEPLOYMENT_RESOURCE_ENTITY, - "! The base model that is required for this deployment if this is for a prompt - "! template or a prompt tune for an IBM foundation model. - BASE_MODEL_ID type STRING, - end of T_DEPLOYMENT_RESOURCE_ENTITY. types: "!"! A prompt to be used to infer the next tokens. Each request
@@ -2201,13 +2668,6 @@ public section. "! extended with new types of moderations. MODERATIONS type T_MODERATIONS, end of T_TEXT_GEN_REQUEST. - types: - "!- "! The transformation results.
- begin of T_GSPTL_TRNSFRMTN_RESP_FIELDS, - "! The transformation results. - RESULTS type T_GSPTL_TRANSFORMATION_RESULTS, - end of T_GSPTL_TRNSFRMTN_RESP_FIELDS. types: "!"! System details.
@@ -2224,79 +2684,41 @@ public section. RESOURCES type STANDARD TABLE OF T_FOUNDATION_MODEL WITH NON-UNIQUE DEFAULT KEY, "! Optional details coming from the service and related to the API call or the "! associated resource. - SYSTEM type T_SYSTEM_TG_DETAILS, + SYSTEM type T_SYSTEM_DETAILS, end of T_FOUNDATION_MODELS. + types: + "! No documentation available. + begin of T_WX_PROMPT_PATCH, + "! The prompt's id. This value cannot be set. It is returned in responses + "! only. + ID type STRING, + "! Name used to display the prompt. + NAME type STRING, + "! An optional description for the prompt. + DESCRIPTION type STRING, + "! No documentation available. + TASK_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. + GOVERNANCE_TRACKED type BOOLEAN, + "! No documentation available. + MODEL_VERSION type T_WX_PROMPT_PATCH_MODEL_VER, + "! No documentation available. + PROMPT_VARIABLE type MAP, + "! Input mode in use for the prompt. + INPUT_MODE type STRING, + "! No documentation available. + PROMPT type T_PROMPT, + end of T_WX_PROMPT_PATCH. types: "!"! The rank query.
T_RERANK_QUERY type String. types: - "!- "! The ranked results.
- begin of T_RERANK_RESPONSE_FIELDS, - "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). - MODEL_ID type STRING, - "! The rank query. - QUERY type STRING, - "! The ranked results. - RESULTS type STANDARD TABLE OF T_RERANKED_RESULTS WITH NON-UNIQUE DEFAULT KEY, - "! The time when the response was created. - CREATED_AT type DATETIME, - "! The number of input tokens that were consumed. - INPUT_TOKEN_COUNT type INTEGER, - end of T_RERANK_RESPONSE_FIELDS. - types: - "!- "! The inputs and outputs required to create a transformation
- "! for the given model. - begin of T_GSPTL_TRANSFORMATION_REQ, - "! The `id` of the model to be used for this request. - MODEL_ID type STRING, - "! The input text. - INPUTS type STANDARD TABLE OF T_GSPTL_TRANSFORMATION_DATA WITH NON-UNIQUE DEFAULT KEY, - "! A data location of the input or output data. - OUTPUT type T_GSPTL_TRANSFORMATION_DATA, - "! The space that contains the resource. - SPACE_ID type STRING, - end of T_GSPTL_TRANSFORMATION_REQ. - types: - "!- "! The request entity for an AutoRAG job.
- begin of T_AUTO_RAGREQUEST, - "! The name of the AutoRAG job. - NAME type STRING, - "! The project that contains the resource. Either `space_id` or `project_id` has to - "! be given. - PROJECT_ID type STRING, - "! The space that contains the resource. Either `space_id` or `project_id` has to - "! be given. - SPACE_ID type STRING, - "! A hardware specification. - HARDWARE_SPEC type T_HARDWARE_SPEC, - "! The parameters for an AutoRAG job. - PARAMETERS type T_AUTO_RAGPARAMETERS, - "! A reference to data. - INPUT_DATA_REFERENCES type T_OBJECT_LOCATION, - "! A reference to data. - TEST_DATA_REFERENCES type T_OBJECT_LOCATION, - "! A reference to data. - VECTOR_STORE_REFERENCES type T_OBJECT_LOCATION, - end of T_AUTO_RAGREQUEST. + "! No documentation available. + T_PROMPT_VARIABLE_STRING type String. types: - "!- "! The similarity scores per source string.
- begin of T_SIMILARITY_RESPONSE_FIELDS, - "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). - MODEL_ID type STRING, - "! The similarity scores. - RESULTS type STANDARD TABLE OF T_SIMILARITY_RESULT WITH NON-UNIQUE DEFAULT KEY, - "! The time when the response was created. - CREATED_AT type DATETIME, - "! The number of input tokens that were consumed. - INPUT_TOKEN_COUNT type INTEGER, - end of T_SIMILARITY_RESPONSE_FIELDS. + "! No documentation available. + T_NOTEBOOK_CREATE_RESPONSE type JSONOBJECT. types: "!"! The common fields that can be patched. This is a helper for
@@ -2325,96 +2747,10 @@ public section. "! up to typical_p or higher are kept for generation. TYPICAL_P type NUMBER, end of T_CAI_KIT_TEXT_GEN_PROPERTIES. - types: - "!- "! The definition of the deployment.
- begin of T_DEPLOYMENT_ENTITY, - "! User defined properties specified as key-value pairs. - CUSTOM type JSONOBJECT, - "! A reference to a resource. - ASSET type T_REL, - "! A reference to a resource. - PROMPT_TEMPLATE type T_SIMPLE_REL, - "! Indicates that this is an online deployment. An object has to be specified but - "! can be empty."! Array of patch operations as defined in RFC 6902.
T_JSON_PATCH type STANDARD TABLE OF T_JSON_PATCH_OPERATION WITH NON-UNIQUE DEFAULT KEY. - types: - "!- "! The supported foundation models.
- T_FOUNDATION_MODELS_ARRAY type STANDARD TABLE OF T_FOUNDATION_MODEL WITH NON-UNIQUE DEFAULT KEY. - types: - "!- "! The response from a geospatial transformation request.
- begin of T_GSPTL_TRANSFORMATION_RESP, - "! The specific fields for the geospatial transformation metadata fields. - METADATA type T_GSPTL_TRNSFRMTN_METADATA, - "! The transformation results. - ENTITY type T_GSPTL_TRNSFRMTN_RESP_ENTITY, - end of T_GSPTL_TRANSFORMATION_RESP. - types: - "!- "! A deployment resource.
- begin of T_DEPLOYMENT_RESOURCE, - "! Common metadata for a resource where `project_id` or `space_id` must be present. - "! - METADATA type T_RESOURCE_META, - "! The definition of the deployment. - ENTITY type T_DEPLOYMENT_ENTITY, - end of T_DEPLOYMENT_RESOURCE. - types: - "!- "! The common fields that can be patched. This is a helper for
- "! `cpdctl`. - begin of T_COMMON_PATCH_REQUEST_HELPER, - "! A list of tags for this resource. - TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The name of the resource. - NAME type STRING, - "! A description of the resource. - DESCRIPTION type STRING, - "! User defined properties specified as key-value pairs. - CUSTOM type JSONOBJECT, - end of T_COMMON_PATCH_REQUEST_HELPER. - types: - "!- "! The deployment resources.
- begin of T_DPLYMNT_RESOURCE_COLLECTION, - "! The total number of resources. Computed explicitly only when - "! 'total_count=true' query parameter is present. This is in order to - "! avoid performance penalties. - TOTAL_COUNT type INTEGER, - "! The number of items to return in each page. - LIMIT type INTEGER, - "! The reference to the first item in the current page. - FIRST type T_PAGINATION_FIRST, - "! A reference to the first item of the next page, if any. - NEXT type T_PAGINATION_NEXT, - "! A list of deployment resources. - RESOURCES type STANDARD TABLE OF T_DEPLOYMENT_RESOURCE WITH NON-UNIQUE DEFAULT KEY, - "! System details including warnings. - SYSTEM type T_DEPLOYMENT_SYSTEM, - end of T_DPLYMNT_RESOURCE_COLLECTION. types: "!"! A list of tags for this resource.
@@ -2451,30 +2787,91 @@ public section. end of T_TRAIN_RESOURCE_ENTITY_COMMON. types: "! No documentation available. - begin of T_GSPTL_TRNSFRMTN_REQ_FIELDS, - "! The space that contains the resource. - SPACE_ID type STRING, - end of T_GSPTL_TRNSFRMTN_REQ_FIELDS. + begin of T_WX_PROMPT_RESPONSE, + "! The prompt's id. This value cannot be set. It is returned in responses + "! only. + ID type STRING, + "! Name used to display the prompt. + NAME type STRING, + "! An optional description for the prompt. + DESCRIPTION type STRING, + "! Time the prompt was created. + CREATED_AT type INTEGER, + "! The ID of the original prompt creator. + CREATED_BY type STRING, + "! Time the prompt was updated. + LAST_UPDATED_AT type INTEGER, + "! The ID of the last user that modifed the prompt. + LAST_UPDATED_BY type STRING, + "! No documentation available. + TASK_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! No documentation available. + GOVERNANCE_TRACKED type BOOLEAN, + "! No documentation available. + LOCK type T_PROMPT_LOCK, + "! Input mode in use for the prompt. + INPUT_MODE type STRING, + "! No documentation available. + MODEL_VERSION type T_WX_PROMPT_RESP_MODEL_VERSION, + "! No documentation available. + PROMPT_VARIABLES type MAP, + "! No documentation available. + IS_TEMPLATE type BOOLEAN, + "! No documentation available. + RESOURCE_KEY type STRING, + "! No documentation available. + PROMPT type T_PROMPT_WITH_EXTERNAL, + end of T_WX_PROMPT_RESPONSE. + types: + "! No documentation available. + T_NOTEBOOK_REVERT_RESPONSE type JSONOBJECT. types: "!- "! Fail the call if the number of input tokens exceeds the
- "! allowed value. This value can not be greater than the maximum sequence length - "! that the model supports. - T_PARAM_TRUNCATE_INPUT_TOKENS type Integer. + "! Payload for a notebook list request. + begin of T_NOTEBOOK_LIST_BODY, + "! The list of notebooks whose details will be retrieved. + NOTEBOOKS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_NOTEBOOK_LIST_BODY. types: "!- "! The metrics.
- T_TRAINING_MLMETRICS type MAP. + "! Payload for creating a notebook in a project. + begin of T_NOTEBOOK_CRE_BODY_IN_PROJECT, + "! The name of the new notebook. + NAME type STRING, + "! A more verbose description of the notebook. + DESCRIPTION type STRING, + "! The reference to the file in the object storage. + FILE_REFERENCE type STRING, + "! The notebook origin. + ORIGINATES_FROM type T_NOTEBOOK_ORIGIN, + "! A notebook runtime. + RUNTIME type T_NOTEBOOK_RUNTIME, + "! A notebook kernel. + KERNEL type T_NOTEBOOK_KERNEL, + "! The guid of the project in which to create the notebook. + PROJECT type STRING, + end of T_NOTEBOOK_CRE_BODY_IN_PROJECT. + types: + "!+ "! Information of a copied notebook as returned by a GET
+ "! request. + begin of T_NOTEBOOK_FOR_COPY, + "! Metadata of a notebook in a project. + METADATA type T_NOTEBOOK_METADATA_IN_PROJECT, + "! Entity of a notebook copied from a source. + ENTITY type T_NOTEBOOK_ENTITY_FOR_COPY, + end of T_NOTEBOOK_FOR_COPY. types: "!- "! The name of the AutoRAG job.
- T_AUTO_RAGNAME type String. + "! The metrics. + T_TRAINING_MLMETRICS type MAP. types: "!"! System details.
begin of T_SIMILARITY_RESPONSE, "! The `id` of the model to be used for this request. Please refer to the [list of - "! models](TBD). + "! models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-mod + "! els-embed.html?context=wx&audience=wdp). MODEL_ID type STRING, "! The similarity scores. RESULTS type STANDARD TABLE OF T_SIMILARITY_RESULT WITH NON-UNIQUE DEFAULT KEY, @@ -2484,46 +2881,25 @@ public section. INPUT_TOKEN_COUNT type INTEGER, "! Optional details coming from the service and related to the API call or the "! associated resource. - SYSTEM type T_SYSTEM_TG_DETAILS, + SYSTEM type T_SYSTEM_DETAILS, end of T_SIMILARITY_RESPONSE. types: "!"! The time when the response was created.
T_CREATED_AT type DATETIME. types: - "! No documentation available. - begin of T_RESULTS_REFERENCE_OUTPUT, - "! The training results. Normally this is specified as `type=container` which - "! means- "! System details.
- begin of T_FOUNDATION_MODEL_TASKS, - "! The total number of resources. - TOTAL_COUNT type INTEGER, - "! The number of items to return in each page. - LIMIT type INTEGER, - "! The reference to the first item in the current page. - FIRST type T_PAGINATION_FIRST, - "! A reference to the first item of the next page, if any. - NEXT type T_PAGINATION_NEXT, - "! The supported foundation model tasks. - RESOURCES type STANDARD TABLE OF T_FOUNDATION_MODEL_TASK WITH NON-UNIQUE DEFAULT KEY, - "! Optional details coming from the service and related to the API call or the - "! associated resource. - SYSTEM type T_SYSTEM_TG_DETAILS, - end of T_FOUNDATION_MODEL_TASKS. + "! No documentation available. + begin of T_RESULTS_REFERENCE_OUTPUT, + "! The training results. Normally this is specified as `type=container` which means + "! that it is stored in the space or project. Note that the training will add some + "! fields that point to the training status, the model request and the + "! assets."! Array parameter type for method DEPLOYMENTS_UPDATE
@@ -2532,166 +2908,191 @@ public section. constants: "!List of required fields per type.
begin of C_REQUIRED_FIELDS, - T_ERROR_ITEM type string value '|CODE|MESSAGE|', - T_ERROR type string value '|TRACE|ERRORS|', T_PRMPT_TUNING_METRICS_CONTEXT type string value '|', T_METRICS_CONTEXT type string value '|', T_MESSAGE type string value '|', + T_API_ERROR_TARGET type string value '|TYPE|NAME|', + T_API_ERROR type string value '|CODE|MESSAGE|', + T_API_ERROR_RESPONSE type string value '|TRACE|ERRORS|', T_TRAINING_METRIC type string value '|', T_TRAINING_STATUS type string value '|STATE|', - T_DATA_SCHEMA type string value '|ID|FIELDS|', - T_RESOURCE_COMMIT_INFO type string value '|COMMITTED_AT|', - T_WARNING type string value '|MESSAGE|', - T_TRAIN_RSRC_COLLECTION_SYS type string value '|', - T_OBJECT_LOCATION type string value '|TYPE|LOCATION|', - T_BASE_MODEL type string value '|', - T_RESOURCE_META type string value '|ID|CREATED_AT|', - T_DATA_CONNECTION_REFERENCE type string value '|TYPE|', - T_PROMPT_TUNING type string value '|TASK_ID|', - T_TRAINING_RESOURCE_ENTITY type string value '|RESULTS_REFERENCE|STATUS|', - T_TRAINING_RESOURCE type string value '|', - T_PAGINATION_FIRST type string value '|HREF|', - T_PAGINATION_NEXT type string value '|HREF|', - T_TRAINING_RESOURCE_COLLECTION type string value '|LIMIT|FIRST|', + T_NOTEBOOK_ORIGIN_FROM_SOURCE type string value '|', T_TRAINING_NUM_EPOCHS type string value '|', - T_MASK_PROPERTIES type string value '|', - T_PII_PROPERTIES type string value '|', T_LIFE_CYCLE_STATE type string value '|ID|', T_CONSUMPTIONS_LIMIT type string value '|', T_TRAINING_INIT_METHOD type string value '|', - T_TRAINING_MAX_OUTPUT_TOKENS type string value '|', - T_TRAINING_LEARNING_RATE type string value '|', - T_TRAINING_BATCH_SIZE type string value '|', - T_TRAINING_NUM_VIRTUAL_TOKENS type string value '|', - T_TRAINING_ACCUMULATED_STEPS type string value '|', - T_TRAINING_TORCH_DTYPE type string value '|', - T_TRAINING_VERBALIZER type string value '|', - T_TRAINING_MAX_INPUT_TOKENS type string value '|', - T_TRAINING_INIT_TEXT type string value '|', - T_TRAINING_PARAMETERS type string value '|', - T_TASK_RATING type string value '|', - T_TASK_DESCRIPTION type string value '|ID|', - T_FOUNDATION_MODEL_VERSION type string value '|', - T_MODEL_LIMITS type string value '|', - T_FOUNDATION_MODEL_LIMITS type string value '|', - T_FOUNDATION_MODEL type string value '|MODEL_ID|LABEL|PROVIDER|SHORT_DESCRIPTION|TASKS|TIER|SOURCE|MIN_SHOT_SIZE|NUMBER_PARAMS|', + T_DATA_SCHEMA type string value '|ID|FIELDS|', + T_NTBK_VER_ENTITY_IN_PROJECT type string value '|PROJECT_ID|', + T_TEXT_MODERATION type string value '|', + T_MASK_PROPERTIES type string value '|', + T_MDRTN_HAP_INPUT_PROPERTIES type string value '|', + T_TEXT_GEN_TOP_TOKEN_INFO type string value '|', + T_WARNING type string value '|MESSAGE|', + T_SYSTEM_DETAILS type string value '|', T_MODERATION_TEXT_RANGE type string value '|START|END|', T_MODERATION_RESULT type string value '|SCORE|INPUT|POSITION|ENTITY|', T_MODERATION_RESULTS type string value '|', - T_WARNING_TG type string value '|MESSAGE|', - T_TEXT_GEN_TOP_TOKEN_INFO type string value '|', T_TEXT_GEN_TOKEN_INFO type string value '|', T_TEXT_GEN_RESULT type string value '|GENERATED_TEXT|STOP_REASON|', - T_SYSTEM_TG_DETAILS type string value '|', T_TEXT_GEN_RESPONSE type string value '|MODEL_ID|CREATED_AT|RESULTS|', - T_FOUNDATION_MODEL_TASK type string value '|TASK_ID|LABEL|RANK|', T_STATS type string value '|', T_DEPLOYMENT_SYSTEM_DETAILS type string value '|', T_DEPLOYMENT_SYSTEM type string value '|', - T_RESOURCE_META_BASE type string value '|', + T_ERROR_TARGET type string value '|TYPE|NAME|', + T_ERROR type string value '|CODE|MESSAGE|', + T_NOTEBOOK_KERNEL type string value '|', + T_NOTEBOOK_METADATA type string value '|', + T_NOTEBOOK_RUNTIME type string value '|ENVIRONMENT|', + T_NOTEBOOK_ORIGIN type string value '|', + T_NOTEBOOK_ENTITY_DEFINITION type string value '|', + T_NOTEBOOK_ENTITY type string value '|', + T_NOTEBOOK type string value '|', + T_WX_PRMPT_SSSN_ENTRY_LST_RSL1 type string value '|', + T_WX_PROMPT_SESSION_ENTRY_LIST type string value '|', T_RESOURCE_META_SIMPLE type string value '|ID|CREATED_AT|', - T_AUTO_RAGMETRICS type string value '|TEST_DATA|', + T_NOTEBOOK_COPY_BODY type string value '|NAME|SOURCE_GUID|', T_TRAINING_RESOURCE_DETAILS type string value '|NAME|', T_HAP_PROPERTIES type string value '|', - T_AUTO_RAGRESULT_LOCATION type string value '|', - T_SIMILARITY_PARAMETERS type string value '|', - T_SIMILARITY_REQUEST type string value '|MODEL_ID|SOURCE_TEXT|TARGET_TEXTS|', - T_TEXT_MODERATION type string value '|', - T_MODERATION_PROPERTIES type string value '|', + T_WX_PROMPT_INPUT_REQUEST type string value '|', + T_RESOURCE_COMMIT_INFO type string value '|COMMITTED_AT|', + T_OBJECT_LOCATION type string value '|TYPE|LOCATION|', + T_DATA_CONNECTION_REFERENCE type string value '|TYPE|', + T_BASE_MODEL type string value '|', + T_PROMPT_TUNING type string value '|TASK_ID|', T_TRAINING_RESOURCE_PROTOTYPE type string value '|NAME|RESULTS_REFERENCE|', T_TEXT_TOKENIZE_PARAMETERS type string value '|', T_TEXT_TOKENIZE_REQUEST type string value '|MODEL_ID|INPUT|', - T_HARDWARE_SPEC type string value '|', - T_TRAINING_STATUS_OUTPUT type string value '|STATUS|', - T_AUTO_RAGMETRIC type string value '|', - T_RERANK_RETURN_OPTIONS type string value '|', + T_NOTEBOOK_RESOURCE_ENTITY_RT type string value '|', T_TEXT_GEN_RESPONSE_FIELDS type string value '|MODEL_ID|CREATED_AT|RESULTS|', - T_AUTO_RAGEMBEDDINGS type string value '|', - T_AUTO_RAGCHUNKING type string value '|', - T_AUTO_RAGVECTOR_STORE type string value '|', - T_AUTO_RAGGENERATION type string value '|', - T_AUTO_RAGMETHOD type string value '|', - T_AUTO_RAGSETTINGS type string value '|', - T_AUTO_RAGPATTERN type string value '|', - T_AUTO_RAGOPTIMIZATION_PARAM type string value '|', - T_AUTO_RAGPARAMETERS type string value '|', - T_AUTO_RAGCONTEXT type string value '|', - T_AUTO_RAGRESULTS type string value '|', - T_AUTO_RAGRESPONSE_ENTITY type string value '|HARDWARE_SPEC|INPUT_DATA_REFERENCES|TEST_DATA_REFERENCES|VECTOR_STORE_REFERENCES|RESULTS|TIMESTAMP|', - T_RERANK_INPUT type string value '|TEXT|', - T_AUTO_RAGMETADATA type string value '|ID|CREATED_AT|', - T_AUTO_RAGRESPONSE type string value '|', - T_AUTO_RAGRESPONSE_RESULTS type string value '|RESULTS|TIMESTAMP|', - T_AUTO_RAGREQUEST_FIELDS type string value '|', T_RETURN_OPTION_PROPERTIES type string value '|', T_MODERATION_HAP_PROPERTIES type string value '|', T_MODERATION_PII_PROPERTIES type string value '|', - T_MODERATIONS type string value '|', T_TEXT_GEN_LENGTH_PENALTY type string value '|', T_DPLYMNT_TEXT_GEN_PROPERTIES type string value '|', + T_MODERATIONS type string value '|', T_DEPLOYMENT_TEXT_GEN type string value '|', T_EMBEDDING type string value '|EMBEDDING|', T_EMBEDDINGS_RESPONSE_FIELDS type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', - T_GSPTL_TRANSFORMATION_DATA type string value '|', - T_GSPTL_TRANSFORMATION_RESULTS type string value '|', - T_GSPTL_TRNSFRMTN_RESP_ENTITY type string value '|MODEL_ID|INPUTS|OUTPUT|RESULTS|', + T_EXTRNL_INFRMTN_EXTRNL_MODEL type string value '|NAME|URL|', + T_EXTRNL_INFRMTN_EXTRNL_PROMPT type string value '|URL|', + T_EXTERNAL_INFORMATION type string value '|EXTERNAL_PROMPT_ID|EXTERNAL_MODEL_ID|EXTERNAL_MODEL_PROVIDER|', + T_CHAT_ITEM type string value '|', + T_PRMPT_WTH_EXTRNL_MODEL_PARAM type string value '|', + T_PROMPT_DATA type string value '|', + T_PROMPT_WITH_EXTERNAL type string value '|MODEL_ID|DATA|', T_SIMPLE_REL type string value '|ID|', T_EMBEDDING_RETURN_OPTIONS type string value '|', T_EMBEDDING_PARAMETERS type string value '|', - T_AUTO_RAGREQUEST_ENTITY type string value '|HARDWARE_SPEC|INPUT_DATA_REFERENCES|TEST_DATA_REFERENCES|VECTOR_STORE_REFERENCES|', - T_GSPTL_TRNSFRMTN_METADATA type string value '|ID|CREATED_AT|SPACE_ID|', - T_REL type string value '|ID|', T_ONLINE_DEPLOYMENT_PARAMETERS type string value '|', T_ONLINE_DEPLOYMENT type string value '|', + T_HARDWARE_SPEC type string value '|', + T_REL type string value '|ID|', T_DPLYMNT_RESOURCE_PROTOTYPE type string value '|NAME|ONLINE|', - T_EMBEDDINGS_RESPONSE type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', - T_GSPTL_TRANSFORMATION_ENTITY type string value '|MODEL_ID|INPUTS|OUTPUT|', - T_AUTO_RAGMETADATA_FIELDS type string value '|', - T_PROMPT_TEMPLATE_VARIABLES type string value '|', - T_SYSTEM_DETAILS type string value '|', + T_NOTEBOOK_VERSION_ENTITY type string value '|', + T_NOTEBOOK_CREATE_BODY_GENERAL type string value '|NAME|FILE_REFERENCE|RUNTIME|', + T_PROMPT_MODEL_PARAMETERS type string value '|', + T_PAGINATION_FIRST type string value '|HREF|', + T_PAGINATION_NEXT type string value '|HREF|', T_PAGINATION type string value '|LIMIT|FIRST|', - T_DEPLOYMENT_TEXT_GEN_REQUEST type string value '|INPUT|', - T_TEXT_GEN_PARAMETERS2 type string value '|', + T_RESOURCE_META type string value '|ID|CREATED_AT|', T_RESULTS_REFERENCE_INPUT type string value '|RESULTS_REFERENCE|', - T_ENTITY_REQ_SPC_PROJECT_BODY type string value '|NAME|', - T_SYSTEM_TG type string value '|', - T_RERANK_PARAMETERS type string value '|', + T_NOTEBOOK_VERSION_METADATA type string value '|', + T_NOTEBOOK_VERSION_IN_PROJECT type string value '|', + T_NTBK_VER_CRE_RESP_NTBK_VER_1 type string value '|', + T_NOTEBOOK_METADATA_IN_PROJECT type string value '|PROJECT_ID|', + T_NOTEBOOK_IN_PROJECT type string value '|', + T_MODEL_LIMITS type string value '|', T_INFERENCE type string value '|URL|', T_DEPLOYMENT_STATUS type string value '|', + T_PROMPT type string value '|MODEL_ID|DATA|', + T_PROMPT_LOCK type string value '|LOCKED|', + T_PAGINATION_BASE type string value '|LIMIT|FIRST|', + T_TRAINING_BATCH_SIZE type string value '|', + T_EMBEDDINGS_REQUEST type string value '|MODEL_ID|INPUTS|', + T_WX_PROMPT_POST_MODEL_VERSION type string value '|', + T_NOTEBOOK_RESOURCE_METADATA type string value '|', + T_DEPLOYMENT_RESOURCE_ENTITY type string value '|', + T_NOTEBOOK_REVERT_BODY type string value '|SOURCE|', + T_RERANK_INPUT type string value '|TEXT|', + T_RERANKED_RESULTS type string value '|SCORE|', + T_RERANK_RESPONSE_FIELDS type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', + T_SIMILARITY_RESULT type string value '|SCORE|', + T_SIMILARITY_RESPONSE_FIELDS type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', + T_MDRTN_PII_INPUT_PROPERTIES type string value '|', + T_TRAINING_TORCH_DTYPE type string value '|', + T_DEPLOYMENT_ENTITY type string value '|ONLINE|', + T_NTBK_CRE_RESP_NTBK_IN_PRJCT type string value '|', + T_TRAINING_VERBALIZER type string value '|', + T_TRAINING_MAX_INPUT_TOKENS type string value '|', + T_TRAINING_MAX_OUTPUT_TOKENS type string value '|', + T_TRAINING_LEARNING_RATE type string value '|', + T_TRAINING_NUM_VIRTUAL_TOKENS type string value '|', + T_TRAINING_ACCUMULATED_STEPS type string value '|', + T_TRAINING_INIT_TEXT type string value '|', + T_TRAINING_PARAMETERS type string value '|', + T_TASK_RATING type string value '|', + T_TASK_DESCRIPTION type string value '|ID|', + T_FOUNDATION_MODEL_VERSION type string value '|', + T_FOUNDATION_MODEL_LIMITS type string value '|', + T_FOUNDATION_MODEL type string value '|MODEL_ID|LABEL|PROVIDER|SHORT_DESCRIPTION|INPUT_TIER|OUTPUT_TIER|SOURCE|NUMBER_PARAMS|', + T_COMMON_PATCH_REQUEST_HELPER type string value '|', + T_EXTRNL_PRMPT_ADDTNL_INFRMTN1 type string value '|', + T_DEPLOYMENT_RESOURCE type string value '|', + T_DPLYMNT_RESOURCE_COLLECTION type string value '|LIMIT|FIRST|', + T_FOUNDATION_MODEL_TASK type string value '|TASK_ID|LABEL|RANK|', + T_FOUNDATION_MODEL_TASKS type string value '|LIMIT|FIRST|', + T_WX_PROMPT_RESP_MODEL_VERSION type string value '|', + T_NTBK_VRSNS_LST_RESP_NTBK_VR1 type string value '|TOTAL_RESULTS|RESOURCES|', + T_TRAIN_RSRC_COLLECTION_SYS type string value '|', + T_TRAINING_RESOURCE_ENTITY type string value '|RESULTS_REFERENCE|STATUS|', + T_TRAINING_RESOURCE type string value '|', + T_TRAINING_RESOURCE_COLLECTION type string value '|LIMIT|FIRST|', + T_PII_PROPERTIES type string value '|', + T_NTBK_VER_RTRV_RESP_NTBK_VER1 type string value '|', + T_RESOURCE_META_BASE type string value '|', + T_NTBK_RESOURCE_ENTITY_ASSET type string value '|', + T_WX_PROMPT_PATCH_MODEL_VER type string value '|', + T_MODERATION_PROPERTIES type string value '|', + T_TRAINING_STATUS_OUTPUT type string value '|STATUS|', + T_NOTEBOOK_RESOURCE_ENTITY type string value '|', + T_SYSTEM type string value '|', + T_NOTEBOOK_ENTITY_DEF_FOR_COPY type string value '|', + T_NOTEBOOK_RESOURCE type string value '|', + T_MODERATION_INPUT_PROPERTIES type string value '|', + T_NTBK_RVRT_RESP_NTBK_IN_PRJCT type string value '|', + T_NOTEBOOKS_RESOURCE_LIST type string value '|TOTAL_RESULTS|RESOURCES|', + T_EMBEDDINGS_RESPONSE type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', + T_PROMPT_TEMPLATE_VARIABLES type string value '|', + T_WX_PROMPT_SESSION_ENTRY type string value '|NAME|CREATED_AT|PROMPT|', + T_WX_PROMPT_SESSION type string value '|NAME|', + T_NOTEBOOK_ENTITY_FOR_COPY type string value '|', + T_NTBK_CRE_RESP_NTBK_FOR_COPY type string value '|', + T_TEXT_GEN_PARAMETERS2 type string value '|', + T_ENTITY_REQ_SPC_PROJECT_BODY type string value '|NAME|', T_TEXT_GEN_COMMON type string value '|INPUT|', - T_GSPTL_TRNSFRMTN_MTDT_FIELDS type string value '|SPACE_ID|', T_TEXT_GEN_PARAMETERS type string value '|', + T_NTBK_VERSIONS_LST_IN_PROJECT type string value '|TOTAL_RESULTS|RESOURCES|', T_JSON_PATCH_OPERATION type string value '|OP|PATH|', - T_PAGINATION_BASE type string value '|LIMIT|FIRST|', - T_SIMILARITY_RESULT type string value '|SCORE|', + T_ERROR_RESPONSE type string value '|TRACE|ERRORS|', T_DEPLOYMENT_ENTITY_COMMON type string value '|ONLINE|', - T_EMBEDDINGS_REQUEST type string value '|MODEL_ID|INPUTS|', - T_RERANKED_RESULTS type string value '|SCORE|', T_RERANK_RESPONSE type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', - T_RERANK_REQUEST type string value '|MODEL_ID|INPUTS|QUERY|', + T_NOTEBOOK_UPDATE_BODY type string value '|', + T_WX_PROMPT_POST type string value '|NAME|PROMPT|', T_TEXT_TOKENIZE_RESULT type string value '|TOKEN_COUNT|', T_TEXT_TOKENIZE_RESPONSE type string value '|MODEL_ID|RESULT|', - T_DEPLOYMENT_RESOURCE_ENTITY type string value '|', T_TEXT_GEN_REQUEST type string value '|INPUT|MODEL_ID|', - T_GSPTL_TRNSFRMTN_RESP_FIELDS type string value '|RESULTS|', T_FOUNDATION_MODELS type string value '|LIMIT|FIRST|', - T_RERANK_RESPONSE_FIELDS type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', - T_GSPTL_TRANSFORMATION_REQ type string value '|MODEL_ID|INPUTS|OUTPUT|SPACE_ID|', - T_AUTO_RAGREQUEST type string value '|HARDWARE_SPEC|INPUT_DATA_REFERENCES|TEST_DATA_REFERENCES|VECTOR_STORE_REFERENCES|', - T_SIMILARITY_RESPONSE_FIELDS type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', + T_WX_PROMPT_PATCH type string value '|NAME|PROMPT|', T_DEPLOYMENT_RESOURCE_PATCH type string value '|', T_CAI_KIT_TEXT_GEN_PROPERTIES type string value '|', - T_DEPLOYMENT_ENTITY type string value '|ONLINE|', - T_GSPTL_TRANSFORMATION_RESP type string value '|', - T_DEPLOYMENT_RESOURCE type string value '|', - T_COMMON_PATCH_REQUEST_HELPER type string value '|', - T_DPLYMNT_RESOURCE_COLLECTION type string value '|LIMIT|FIRST|', T_PAGINATION_TC type string value '|LIMIT|FIRST|', T_TRAIN_RESOURCE_ENTITY_COMMON type string value '|', - T_GSPTL_TRNSFRMTN_REQ_FIELDS type string value '|SPACE_ID|', + T_WX_PROMPT_RESPONSE type string value '|NAME|PROMPT|', + T_NOTEBOOK_LIST_BODY type string value '|', + T_NOTEBOOK_CRE_BODY_IN_PROJECT type string value '|NAME|FILE_REFERENCE|RUNTIME|PROJECT|', + T_NOTEBOOK_FOR_COPY type string value '|', T_SIMILARITY_RESPONSE type string value '|MODEL_ID|RESULTS|CREATED_AT|INPUT_TOKEN_COUNT|', T_RESULTS_REFERENCE_OUTPUT type string value '|RESULTS_REFERENCE|', - T_FOUNDATION_MODEL_TASKS type string value '|LIMIT|FIRST|', __DUMMY type string value SPACE, end of C_REQUIRED_FIELDS . @@ -2761,9 +3162,12 @@ constants: MESSAGE type string value 'message', ID type string value 'id', MORE_INFO type string value 'more_info', + ADDITIONAL_PROPERTIES type string value 'additional_properties', WARNINGS type string value 'warnings', SYSTEM type string value 'system', + TYPE type string value 'type', CODE type string value 'code', + TARGET type string value 'target', TRACE type string value 'trace', ERRORS type string value 'errors', RETURN_TOKENS type string value 'return_tokens', @@ -2810,7 +3214,8 @@ constants: LIMITS type string value 'limits', TASK_IDS type string value 'task_ids', TASKS type string value 'tasks', - TIER type string value 'tier', + INPUT_TIER type string value 'input_tier', + OUTPUT_TIER type string value 'output_tier', SOURCE type string value 'source', MIN_SHOT_SIZE type string value 'min_shot_size', NUMBER_PARAMS type string value 'number_params', @@ -2842,7 +3247,6 @@ constants: DEPLOYED_ASSET_TYPE type string value 'deployed_asset_type', STATUS type string value 'status', METADATA type string value 'metadata', - ADDITIONAL_PROPERTIES type string value 'additional_properties', ONLINE_COUNT type string value 'online_count', BATCH_COUNT type string value 'batch_count', STATS type string value 'stats', @@ -2855,7 +3259,6 @@ constants: BASE_MODEL type string value 'base_model', TUNING_TYPE type string value 'tuning_type', FIELDS type string value 'fields', - TYPE type string value 'type', CONNECTION type string value 'connection', LOCATION type string value 'location', SCHEMA type string value 'schema', @@ -2874,51 +3277,63 @@ constants: METRICS type string value 'metrics', INPUTS type string value 'inputs', EMBEDDING type string value 'embedding', - SOURCE_TEXT type string value 'source_text', - TARGET_TEXTS type string value 'target_texts', - TOP_N type string value 'top_n', QUERY type string value 'query', - OBJECTIVE_METRIC type string value 'objective_metric', - MAX_NUM_FOUNDATION_MODELS type string value 'max_num_foundation_models', - INCLUDE_FOUNDATION_MODELS_ONLY type string value 'include_foundation_models_only', - INCLUDE_EMBEDDING_MODELS_ONLY type string value 'include_embedding_models_only', - OPTIMIZATION type string value 'optimization', - OUTPUT_LOGS type string value 'output_logs', - INPUT_DATA_REFERENCES type string value 'input_data_references', - TEST_DATA_REFERENCES type string value 'test_data_references', - VECTOR_STORE_REFERENCES type string value 'vector_store_references', - MEAN type string value 'mean', - TEST_DATA type string value 'test_data', - SYNTHETIC_DATA type string value 'synthetic_data', - EVALUATION_RESULTS type string value 'evaluation_results', - FUNCTION type string value 'function', - FUNCTION_SOURCE_CODE type string value 'function_source_code', - FUNCTION_CREATION_REQUEST type string value 'function_creation_request', - INDEXING_NOTEBOOK type string value 'indexing_notebook', - GENERATE_NOTEBOOK type string value 'generate_notebook', - DATABASE type string value 'database', - INDEX_NAME type string value 'index_name', - DIMENSION type string value 'dimension', - DISTANCE type string value 'distance', - METHOD type string value 'method', - CHUNK_SIZE type string value 'chunk_size', - OVERLAP type string value 'overlap', - STRATEGY type string value 'strategy', - SIZE type string value 'size', - MODEL_NAME type string value 'model_name', + CREATED_BY type string value 'created_by', + LAST_UPDATED_AT type string value 'last_updated_at', + LAST_UPDATED_BY type string value 'last_updated_by', + GOVERNANCE_TRACKED type string value 'governance_tracked', + LOCK type string value 'lock', + INPUT_MODE type string value 'input_mode', + IS_TEMPLATE type string value 'is_template', + RESOURCE_KEY type string value 'resource_key', PROMPT type string value 'prompt', - VECTOR_STORE type string value 'vector_store', - CHUNKING type string value 'chunking', - EMBEDDINGS type string value 'embeddings', - RETRIEVAL type string value 'retrieval', - RERANKING type string value 'reranking', - GENERATION type string value 'generation', - COMPOSITION_STEPS type string value 'composition_steps', - DURATION_SECONDS type string value 'duration_seconds', - SETTINGS type string value 'settings', - RAG_PATTERN type string value 'rag_pattern', - CHAIN_NODES type string value 'chain_nodes', - PHASE type string value 'phase', + PROMPT_VARIABLE type string value 'prompt_variable', + PROMPTS type string value 'prompts', + BOOKMARK type string value 'bookmark', + MODEL_PARAMETERS type string value 'model_parameters', + DATA type string value 'data', + SYSTEM_PROMPT type string value 'system_prompt', + CHAT_ITEMS type string value 'chat_items', + EXTERNAL_INFORMATION type string value 'external_information', + EXTERNAL_PROMPT_ID type string value 'external_prompt_id', + EXTERNAL_MODEL_ID type string value 'external_model_id', + EXTERNAL_MODEL_PROVIDER type string value 'external_model_provider', + EXTERNAL_PROMPT type string value 'external_prompt', + EXTERNAL_MODEL type string value 'external_model', + CONTENT type string value 'content', + INSTRUCTION type string value 'instruction', + INPUT_PREFIX type string value 'input_prefix', + OUTPUT_PREFIX type string value 'output_prefix', + EXAMPLES type string value 'examples', + LOCKED type string value 'locked', + LOCK_TYPE type string value 'lock_type', + LOCKED_BY type string value 'locked_by', + TOTAL_RESULTS type string value 'total_results', + ASSET_TYPE type string value 'asset_type', + CREATED type string value 'created', + OWNER_ID type string value 'owner_id', + CATALOG_ID type string value 'catalog_id', + ASSET_ID type string value 'asset_id', + NOTEBOOK type string value 'notebook', + RUNTIME type string value 'runtime', + KERNEL type string value 'kernel', + ORIGINATES_FROM type string value 'originates_from', + GUID type string value 'guid', + SPARK_MONITORING_ENABLED type string value 'spark_monitoring_enabled', + ENVIRONMENT type string value 'environment', + FILE_REFERENCE type string value 'file_reference', + PROJECT type string value 'project', + SOURCE_GUID type string value 'source_guid', + DISPLAY_NAME type string value 'display_name', + LANGUAGE type string value 'language', + NOTEBOOKS type string value 'notebooks', + MASTER_NOTEBOOK_GUID type string value 'master_notebook_guid', + CREATED_BY_IUI type string value 'created_by_iui', + REV_ID type string value 'rev_id', + ADDITIONAL_INFORMATION type string value 'additional_information', + NUMBER type string value 'number', + TAG type string value 'tag', + KEY type string value 'key', end of C_ABAPNAME_DICTIONARY . @@ -3150,7 +3565,7 @@ constants: "!Generate embeddings
+ "! Generate embeddings from text input.Infer text
"! Infer the next tokens for a given deployed model with a set of parameters.- "! The data returned when an error is encountered.
- begin of T_ERROR, - "! An identifier that can be used to trace the request. - TRACE type STRING, - "! The list of errors. - ERRORS type STANDARD TABLE OF T_ERROR_ITEM WITH NON-UNIQUE DEFAULT KEY, - end of T_ERROR. types: "!"! The location of the intermediate model.
@@ -403,6 +384,37 @@ public section. "! No documentation available. TEXT type STRING, end of T_TRAINING_STATUS_MESSAGE. + types: + "!+ "! The target of the error.
+ begin of T_API_ERROR_TARGET, + "! The type of the problematic field. + TYPE type STRING, + "! The name of the problematic field. + NAME type STRING, + end of T_API_ERROR_TARGET. + types: + "!+ "! An error message.
+ begin of T_API_ERROR, + "! A simple code that should convey the general sense of the error. + CODE type STRING, + "! The message that describes the error. + MESSAGE type STRING, + "! A reference to a more detailed explanation when available. + MORE_INFO type STRING, + "! The target of the error. + TARGET type T_API_ERROR_TARGET, + end of T_API_ERROR. + types: + "!+ "! The data returned when an error is encountered.
+ begin of T_API_ERROR_RESPONSE, + "! An identifier that can be used to trace the request. + TRACE type STRING, + "! The list of errors. + ERRORS type STANDARD TABLE OF T_API_ERROR WITH NON-UNIQUE DEFAULT KEY, + end of T_API_ERROR_RESPONSE. types: "!"! Status of the model.
@@ -428,7 +440,7 @@ public section. "! Metrics that can be returned by an operation. METRICS type STANDARD TABLE OF T_METRIC WITH NON-UNIQUE DEFAULT KEY, "! The data returned when an error is encountered. - FAILURE type T_ERROR, + FAILURE type T_API_ERROR_RESPONSE, end of T_TRAINING_STATUS. types: "! No documentation available. @@ -567,7 +579,7 @@ public section. "! for all pipelines. LOCALIZED_EXTREME type JSONOBJECT, "! trend anomaly refers to a segment of time series, which has a trend change - "! compared to the time series before the segment. Includes scores for all + "! compared to the time series before the segment. Includes scores for all "! pipelines. TREND type JSONOBJECT, "! variance anomaly refers to a segment of time series in which the variance of a @@ -851,7 +863,7 @@ public section. "! An optional message related to the job status. MESSAGE type T_JOB_STATUS_MESSAGE, "! The data returned when an error is encountered. - FAILURE type T_ERROR, + FAILURE type T_API_ERROR_RESPONSE, end of T_JOB_STATUS. types: "!@@ -968,13 +980,11 @@ public section. "!
"! A hardware specification.
begin of T_HARDWARE_SPEC, - "! The id of the hardware specification. One, and only one, of `id` or `name` must - "! be set. + "! The id of the hardware specification. ID type STRING, - "! The revision of the hardware specification if `id` is used. + "! The revision of the hardware specification. REV type STRING, - "! The name of the hardware specification. One, and only one, of `id` or `name` - "! must be set. + "! The name of the hardware specification. NAME type STRING, "! The number of nodes applied to a computation. NUM_NODES type INTEGER, @@ -1115,13 +1125,11 @@ public section. "!"! A software specification.
begin of T_SOFTWARE_SPEC_REL, - "! The id of the software specification. One, and only one, of `id` or `name` must - "! be set. + "! The id of the software specification. ID type STRING, "! The revision of the software specification. REV type STRING, - "! The name of the software specification. One, and only one, of `id` or `name` - "! must be set. + "! The name of the software specification. NAME type STRING, end of T_SOFTWARE_SPEC_REL. types: @@ -1200,6 +1208,8 @@ public section. MESSAGE type STRING, "! An `id` associated with the message. ID type STRING, + "! A reference to a more detailed explanation when available. + MORE_INFO type STRING, "! Additional key-value pairs that depend on the specific warning. ADDITIONAL_PROPERTIES type JSONOBJECT, end of T_WARNING. @@ -1414,13 +1424,22 @@ public section. end of T_MODEL_DEFINITION_ID. types: "!- "! Optional messages related to the deployment.
+ "! Optional messages related to the resource. begin of T_MESSAGE, "! The level of the message, normally one of `debug`, `info` or `warning`. LEVEL type STRING, "! The message. TEXT type STRING, end of T_MESSAGE. + types: + "!+ "! Parameters that can be used to control the prediction
+ "! request. + begin of T_SCORING_PARAMETERS, + "! The forecast window to use for the prediction. If no value is set then the value + "! used during training will be used. + FORECAST_WINDOW type INTEGER, + end of T_SCORING_PARAMETERS. types: "!"! The input data.
@@ -1441,6 +1460,8 @@ public section. begin of T_SYNC_SCORING_DATA, "! The input data. INPUT_DATA type STANDARD TABLE OF T_SYNC_SCORING_DATA_ITEM WITH NON-UNIQUE DEFAULT KEY, + "! Parameters that can be used to control the prediction request. + SCORING_PARAMETERS type T_SCORING_PARAMETERS, end of T_SYNC_SCORING_DATA. types: "!
@@ -2304,10 +2325,10 @@ public section.
begin of T_INSTNC_RESOURCE_ENTITY_PLAN,
"! The payment plan ID.
ID type STRING,
- "! The payment plan name.
+ "! The payment plan name, this can be one of
+ "! `lite`, `v2-standard` or `v2-professional`.
NAME type STRING,
- "! 1 - for v1 plans, 2 - for the v2 plans where v2 plan means an instance is space
- "! / project aware.
+ "! 2 - for the v2 plans where v2 plan means an instance is space / project aware.
VERSION type INTEGER,
end of T_INSTNC_RESOURCE_ENTITY_PLAN.
types:
@@ -2340,7 +2361,7 @@ public section.
types:
"! No documentation available.
begin of T_INSTANCE_RESOURCE_ENTITY,
- "! Status of the service instance (active|inactive).
+ "! Status of the service instance.
STATUS type STRING,
"! No documentation available.
PLAN type T_INSTNC_RESOURCE_ENTITY_PLAN,
@@ -2355,6 +2376,8 @@ public section.
"! Cloud Service Endpoints (CSE) the instance is enabled for. Possible values are
"! `public`, `private` and `public-and-private`.
SERVICE_ENDPOINTS type STRING,
+ "! The `id` of the resource group that contains this instance.
+ RESOURCE_GROUP_ID type STRING,
end of T_INSTANCE_RESOURCE_ENTITY.
types:
"! No documentation available.
@@ -2510,7 +2533,7 @@ public section.
REQUESTED_REPLICAS type INTEGER,
"! The number of replicas currently deployed.
DEPLOYED_REPLICAS type INTEGER,
- "! Optional messages related to the deployment.
+ "! Optional messages related to the resource.
MESSAGE type T_MESSAGE,
end of T_DEPLOYMENT_SCALING.
types:
@@ -2520,10 +2543,10 @@ public section.
begin of T_DEPLOYMENT_STATUS,
"! Specifies the current state of the deployment.
STATE type STRING,
- "! Optional messages related to the deployment.
+ "! Optional messages related to the resource.
MESSAGE type T_MESSAGE,
"! The data returned when an error is encountered.
- FAILURE type T_ERROR,
+ FAILURE type T_API_ERROR_RESPONSE,
"! The URLs that can be used to submit online prediction API requests. These URLs
"! will contain the
"! `deployment_id` and the `serving_name`, if the `serving_name` was set.
@@ -3064,7 +3087,7 @@ public section.
end of T_MODEL_RESOURCE_ENTITY_SIZE.
types:
"!
- "! The model id of the base model for this prompt tuning.
+ "! The model id of the base model for this job. begin of T_BASE_MODEL, "! The model id of the base model. MODEL_ID type STRING, @@ -3075,7 +3098,7 @@ public section. begin of T_TRAINING_DETAILS, "! The `id` of the training job that produced this model. ID type STRING, - "! The model id of the base model for this prompt tuning. + "! The model id of the base model for this job. BASE_MODEL type T_BASE_MODEL, "! The task that is targeted for this model. TASK_ID type STRING, @@ -3214,6 +3237,11 @@ public section. "!"! A list of evaluation specifications.
T_EVALUATIONS_SPEC type STANDARD TABLE OF T_EVALUATIONS_SPEC_ITEM WITH NON-UNIQUE DEFAULT KEY. + types: + "!+ "! The forecast window to use for the prediction. If no value
+ "! is set then the value used during training will be used. + T_SCRNG_PARAM_FORECAST_WINDOW type Integer. types: "!"! The details for the revision.
@@ -4430,8 +4458,6 @@ constants: T_DATA_SCHEMA type string value '|ID|FIELDS|', T_MODEL_ENTITY_SCHEMAS type string value '|', T_TRAINING_STATUS_HPO type string value '|HYPER_PARAMETERS|', - T_ERROR_ITEM type string value '|CODE|MESSAGE|', - T_ERROR type string value '|TRACE|ERRORS|', T_MODEL_LOCATION type string value '|', T_INTERMEDIATE_MODEL type string value '|NAME|PROCESS|', T_FEATURE_IMPORTANCE type string value '|FEATURES|', @@ -4454,6 +4480,9 @@ constants: T_COMPUTE_USAGE_METRICS type string value '|TIMESTAMP|', T_METRIC type string value '|TIMESTAMP|', T_TRAINING_STATUS_MESSAGE type string value '|', + T_API_ERROR_TARGET type string value '|TYPE|NAME|', + T_API_ERROR type string value '|CODE|MESSAGE|', + T_API_ERROR_RESPONSE type string value '|TRACE|ERRORS|', T_TRAINING_STATUS type string value '|STATE|', T_CONSUMPTION_GPU_COUNT type string value '|', T_TOKEN_COUNT type string value '|CURRENT|', @@ -4518,6 +4547,7 @@ constants: T_REMOTE_TRAIN_SYSTEM_RESOURCE type string value '|METADATA|ENTITY|', T_MODEL_DEFINITION_ID type string value '|', T_MESSAGE type string value '|', + T_SCORING_PARAMETERS type string value '|', T_SYNC_SCORING_DATA_ITEM type string value '|', T_SYNC_SCORING_DATA type string value '|INPUT_DATA|', T_MODEL_REFERENCE type string value '|ID|', @@ -4836,6 +4866,7 @@ constants: CODE type string value 'code', MESSAGE type string value 'message', MORE_INFO type string value 'more_info', + TARGET type string value 'target', TRACE type string value 'trace', ERRORS type string value 'errors', RUNNING_AT type string value 'running_at', @@ -4873,7 +4904,9 @@ constants: PATH type string value 'path', VALUE type string value 'value', VALUES type string value 'values', + FORECAST_WINDOW type string value 'forecast_window', INPUT_DATA type string value 'input_data', + SCORING_PARAMETERS type string value 'scoring_parameters', TARGETS type string value 'targets', PREDICTIONS type string value 'predictions', INPUT_DATA_REFERENCES type string value 'input_data_references', @@ -4905,6 +4938,7 @@ constants: ACCOUNT type string value 'account', CONSUMPTION type string value 'consumption', SERVICE_ENDPOINTS type string value 'service_endpoints', + RESOURCE_GROUP_ID type string value 'resource_group_id', MAXIMIZE type string value 'maximize', METHOD type string value 'method', ITEMS type string value 'items', @@ -5154,15 +5188,13 @@ constants: "! parameter is not currently supported.