sap-ai-sdk-core 2.9.9__py3-none-any.whl → 3.0.3__py3-none-any.whl

ai_core_sdk/tracking/tracking.py

@@ -0,0 +1,215 @@
+# pylint: disable=C0114
+import os
+from typing import Callable, List
+
+from ai_api_client_sdk.helpers.authenticator import Authenticator
+from ai_core_sdk.exception import AIAPIAuthenticatorException
+from ai_core_sdk.helpers import is_within_aicore
+from ai_core_sdk.models import Metric, MetricCustomInfo, MetricsQueryResponse, MetricTag
+from ai_core_sdk.resource_clients import AIAPIV2Client
+from ai_core_sdk.resource_clients.internal_rest_client import InternalRestClient
+from ai_core_sdk.resource_clients.metrics_client import MetricsCoreClient
+
+
+class Tracking(MetricsCoreClient): # pylint: disable=W0223
+    """Tracking is a class implemented for interacting with the metrics related
+    endpoints of the server. It is a wrapper around the base class
+    :class:`ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient`
+
+    :param base_url: Base URL of the AI Core. Should include the base path as well. (i.e., "<base_url>/lm/scenarios"
+    should work)
+    :type base_url: str
+    :param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to
+        None
+    :type auth_url: str, optional
+    :param client_id: client id to be used for authorization, defaults to None
+    :type client_id: str, optional
+    :param client_secret: client secret to be used for authorization, defaults to None
+    :type client_secret: str, optional
+    :param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
+    :type cert_str: str, optional
+    :param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
+    :type key_str: str, optional
+    :param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
+        defaults to None
+    :type cert_file_path: str, optional
+    :param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
+        defaults to None
+    :type key_file_path: str, optional
+    :param token_creator: the function which returns the Bearer token, when called. Either this, or
+        auth_url & client_id & client_secret should be specified, defaults to None
+    :type token_creator: Callable[[], str], optional
+    :param resource_group: The default resource group which will be used while sending the requests to the server. If
+        not set, the resource_group should be specified with every request to the server, defaults to None
+    :type resource_group: str, optional
+    """
+    def __init__(self, base_url: str = None, auth_url: str = None, client_id: str = None, client_secret: str = None, # pylint: disable=W0231,R0913
+                 cert_str: str = None, key_str: str = None, cert_file_path: str = None, key_file_path: str = None,
+                 token_creator: Callable[[], str] = None, resource_group: str = None):
+        self.base_url: str = base_url
+        self.metrics_path = '/metrics'
+        self.local_experimentation = False
+        ai_api_base_url = f'{base_url}/lm'
+
+        if base_url:
+            token_creator = AIAPIV2Client._create_token_creator_if_does_not_exist(
+                token_creator=token_creator, auth_url=auth_url, client_id=client_id, client_secret=client_secret,
+                cert_str=cert_str, key_str=key_str, cert_file_path=cert_file_path, key_file_path=key_file_path)
+            ai_api_v2_client  = AIAPIV2Client(base_url=ai_api_base_url, token_creator=token_creator,
+                                              resource_group=resource_group)
+            self.metrics_core_client = MetricsCoreClient(rest_client = ai_api_v2_client.rest_client)
+        elif is_within_aicore():
+            self.metrics_core_client = MetricsCoreClient(
+                rest_client=InternalRestClient(),
+                execution_id=os.getenv("AICORE_EXECUTION_ID"),
+            )
+        else:
+            print('Warning: Enabling local experimentation. Metrics logged will not be persisted anywhere.')
+            self.local_experimentation = True
+
+    def modify(self, execution_id: str = '', metrics: List[Metric] = None, tags: List[MetricTag] = None, # pylint: disable=R0913
+               custom_info: List[MetricCustomInfo] = None, resource_group: str = None) -> None:
+        """Creates or updates the metrics for an execution.
+
+        :param execution_id: ID of the execution, of which the metrics should be modified.
+        :type execution_id: str
+        :param metrics: List of the metrics related to the execution, defaults to None
+        :type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional
+        :param tags: List of the tags related to the execution, defaults to None
+        :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional
+        :param custom_info: List of custom info related to the execution, defaults to None
+        :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
+        :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+            resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+            defaults to None
+        :type resource_group: str
+        :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+    server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+            server
+        """
+        if not self.local_experimentation:
+            self.metrics_core_client.modify(execution_id=execution_id, metrics=metrics, tags=tags,
+               custom_info=custom_info, resource_group=resource_group)
+
+    def log_metrics(self, metrics: List[Metric], execution_id: str = '', artifact_name: str = None,
+                    resource_group: str = None) -> None:
+        """Creates or updates the metrics for an execution.
+
+        :param metrics: List of the metrics related to the execution,
+        :type metrics: List[class:`ai_api_client_sdk.metric.Metric`]
+        :param execution_id: ID of the execution, of which the metrics should be modified.
+        :type execution_id: str
+        :param artifact_name: Name of the artifact to associate with a metric, defaults to None
+        :type artifact_name: str
+        :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+            resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+            defaults to None
+        :type resource_group: str
+        :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+    server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+            server
+        """
+        if not self.local_experimentation:
+            self.metrics_core_client.log_metrics(metrics=metrics,
+                                                 execution_id=execution_id,
+                                                 artifact_name=artifact_name,
+                                                 resource_group=resource_group)
+
+    def set_custom_info(self, custom_info: List[MetricCustomInfo], execution_id: str = '',
+                        resource_group: str = None) -> None:
+        """log custom info against the given execution
+        captures consumption semantics for the metrics or complex metric in JSON format.
+
+
+        :param custom_info: List of custom info related to the execution
+        :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
+        :param execution_id: ID of the execution, of which the metrics should be modified.
+        :type execution_id: str
+        :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+            resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+            defaults to None
+        :type resource_group: str
+        :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+    server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+            server
+        """
+        if not self.local_experimentation:
+            self.metrics_core_client.set_custom_info(custom_info=custom_info, execution_id=execution_id,
+                        resource_group=resource_group)
+
+    def set_tags(self, tags: List[MetricTag], execution_id: str = '', resource_group: str = None) -> None:
+        """log tags against the given execution
+
+        :param tags: List of the tags related to the execution, defaults to None
+        :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag']
+        :param execution_id: ID of the execution, of which the metrics should be modified.
+        :type execution_id: str
+        :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+            resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+            defaults to None
+        :type resource_group: str
+        :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+    server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+            server
+        """
+        if not self.local_experimentation:
+            self.metrics_core_client.set_tags(tags=tags, execution_id=execution_id, resource_group=resource_group)
+
+    def query(self, filter: str = None, execution_ids: List[str] = None, # pylint: disable=W0622
+              select: List[str] = None, resource_group: str = None) -> \
+            MetricsQueryResponse:
+        """Creates or updates the metrics for an execution.
+
+        :param filter: Deprecated. Use parameter execution_ids instead. A filter expression that filters the metric
+            resources using execution IDs. User can only use in, eq operators in filter expression, defaults to None
+        :type filter: str, optional
+        :param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
+        :type execution_ids: List[str], optional
+        :param select: Values of select can be metrics,tags,customInfo or any of the combinations of these or *.
+            Can be used to select(project) only the resources specified
+        :type select: List[str], optional
+        :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+            resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+            defaults to None
+        :type resource_group: str
+        :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+            server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the
+            server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+            server
+        :return: An object representing the response from the server
+        :rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
+        """
+        if self.local_experimentation:
+            print('Warning: Response will be always empty')
+            return MetricsQueryResponse.from_dict({"count":0,"resources":[]})
+        return self.metrics_core_client.query(filter=filter,
+                                              execution_ids=execution_ids,
+                                              select=select,
+                                              resource_group=resource_group)
+
+    def delete(self, execution_id: str, resource_group: str = None) -> None:
+        """Deletes the metrics.
+
+        :param execution_id: ID of the execution, of which the metrics should be deleted.
+        :type execution_id: str
+        :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+            resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+            defaults to None
+        :type resource_group: str
+        :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+            server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the
+            server
+        :raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the
+            server
+        :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+            server
+        """
+        if not self.local_experimentation:
+            self.metrics_core_client.delete(execution_id=execution_id, resource_group=resource_group)

sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.ai_core_v2_client.html

@@ -0,0 +1,127 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head><title>Python: module ai_core_sdk.ai_core_v2_client</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+</head><body bgcolor="#f0f0f8">
+
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
+<tr bgcolor="#7799ee">
+<td valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="ai_core_sdk.html"><font color="#ffffff">ai_core_sdk</font></a>.ai_core_v2_client</strong></big></big></font></td
+><td align=right valign=bottom
+><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/ai_core_v2_client.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/ai_core_v2_client.py</a></font></td></tr></table>
+    <p></p>
+<p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#aa55cc">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
+    
+<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
+</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ee77aa">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
+    
+<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<td width="100%"><dl>
+<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
+</font></dt><dd>
+<dl>
+<dt><font face="helvetica, arial"><a href="ai_core_sdk.ai_core_v2_client.html#AICoreV2Client">AICoreV2Client</a>
+</font></dt></dl>
+</dd>
+</dl>
+ <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#000000" face="helvetica, arial"><a name="AICoreV2Client">class <strong>AICoreV2Client</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
+    
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
+<td colspan=2><tt><a href="#AICoreV2Client">AICoreV2Client</a>(base_url:&nbsp;str,&nbsp;auth_url:&nbsp;str&nbsp;=&nbsp;None,&nbsp;client_id:&nbsp;str&nbsp;=&nbsp;None,&nbsp;client_secret:&nbsp;str&nbsp;=&nbsp;None,&nbsp;cert_str:&nbsp;str&nbsp;=&nbsp;None,&nbsp;key_str:&nbsp;str&nbsp;=&nbsp;None,&nbsp;cert_file_path:&nbsp;str&nbsp;=&nbsp;None,&nbsp;key_file_path:&nbsp;str&nbsp;=&nbsp;None,&nbsp;token_creator:&nbsp;Callable[[],&nbsp;str]&nbsp;=&nbsp;None,&nbsp;resource_group:&nbsp;str&nbsp;=&nbsp;None,&nbsp;read_timeout=60,&nbsp;connect_timeout=60,&nbsp;num_request_retries=3)<br>
+&nbsp;<br>
+The&nbsp;<a href="#AICoreV2Client">AICoreV2Client</a>&nbsp;is&nbsp;the&nbsp;class&nbsp;implemented&nbsp;to&nbsp;interact&nbsp;with&nbsp;the&nbsp;AI&nbsp;Core&nbsp;endpoints.&nbsp;The&nbsp;user&nbsp;can&nbsp;use&nbsp;its<br>
+attributes&nbsp;corresponding&nbsp;to&nbsp;the&nbsp;resources,&nbsp;for&nbsp;interacting&nbsp;with&nbsp;endpoints&nbsp;related&nbsp;to&nbsp;that&nbsp;resource.&nbsp;(i.e.,<br>
+aicoreclient.scenario)<br>
+&nbsp;<br>
+:param&nbsp;base_url:&nbsp;Base&nbsp;URL&nbsp;of&nbsp;the&nbsp;AI&nbsp;Core.&nbsp;Should&nbsp;include&nbsp;the&nbsp;base&nbsp;path&nbsp;as&nbsp;well.&nbsp;(i.e.,&nbsp;"&lt;base_url&gt;/lm/scenarios"<br>
+&nbsp;&nbsp;&nbsp;&nbsp;should&nbsp;work)<br>
+:type&nbsp;base_url:&nbsp;str<br>
+:param&nbsp;auth_url:&nbsp;URL&nbsp;of&nbsp;the&nbsp;authorization&nbsp;endpoint.&nbsp;Should&nbsp;be&nbsp;the&nbsp;full&nbsp;URL&nbsp;(including&nbsp;/oauth/token),&nbsp;defaults&nbsp;to<br>
+&nbsp;&nbsp;&nbsp;&nbsp;None<br>
+:type&nbsp;auth_url:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;client_id:&nbsp;client&nbsp;id&nbsp;to&nbsp;be&nbsp;used&nbsp;for&nbsp;authorization,&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;client_id:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;client_secret:&nbsp;client&nbsp;secret&nbsp;to&nbsp;be&nbsp;used&nbsp;for&nbsp;authorization,&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;client_secret:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;cert_str:&nbsp;certificate&nbsp;file&nbsp;content,&nbsp;needs&nbsp;to&nbsp;be&nbsp;provided&nbsp;alongside&nbsp;the&nbsp;key_str&nbsp;parameter,&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;cert_str:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;key_str:&nbsp;key&nbsp;file&nbsp;content,&nbsp;needs&nbsp;to&nbsp;be&nbsp;provided&nbsp;alongside&nbsp;the&nbsp;cert_str&nbsp;parameter,&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;key_str:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;cert_file_path:&nbsp;path&nbsp;to&nbsp;the&nbsp;certificate&nbsp;file,&nbsp;needs&nbsp;to&nbsp;be&nbsp;provided&nbsp;alongside&nbsp;the&nbsp;key_file_path&nbsp;parameter,<br>
+&nbsp;&nbsp;&nbsp;&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;cert_file_path:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;key_file_path:&nbsp;path&nbsp;to&nbsp;the&nbsp;key&nbsp;file,&nbsp;needs&nbsp;to&nbsp;be&nbsp;provided&nbsp;alongside&nbsp;the&nbsp;cert_file_path&nbsp;parameter,<br>
+&nbsp;&nbsp;&nbsp;&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;key_file_path:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;token_creator:&nbsp;the&nbsp;function&nbsp;which&nbsp;returns&nbsp;the&nbsp;Bearer&nbsp;token,&nbsp;when&nbsp;called.&nbsp;Either&nbsp;this,&nbsp;or<br>
+&nbsp;&nbsp;&nbsp;&nbsp;auth_url&nbsp;&amp;&nbsp;client_id&nbsp;&amp;&nbsp;client_secret&nbsp;should&nbsp;be&nbsp;specified,&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;token_creator:&nbsp;Callable[[],&nbsp;str],&nbsp;optional<br>
+:param&nbsp;resource_group:&nbsp;The&nbsp;default&nbsp;resource&nbsp;group&nbsp;which&nbsp;will&nbsp;be&nbsp;used&nbsp;while&nbsp;sending&nbsp;the&nbsp;requests&nbsp;to&nbsp;the&nbsp;server.&nbsp;If<br>
+&nbsp;&nbsp;&nbsp;&nbsp;not&nbsp;set,&nbsp;the&nbsp;resource_group&nbsp;should&nbsp;be&nbsp;specified&nbsp;with&nbsp;every&nbsp;request&nbsp;to&nbsp;the&nbsp;server,&nbsp;defaults&nbsp;to&nbsp;None<br>
+:type&nbsp;resource_group:&nbsp;str,&nbsp;optional<br>
+:param&nbsp;read_timeout:&nbsp;Read&nbsp;timeout&nbsp;for&nbsp;requests&nbsp;in&nbsp;seconds,&nbsp;defaults&nbsp;to&nbsp;60s<br>
+:type&nbsp;read_timeout:&nbsp;int<br>
+:param&nbsp;connect_timeout:&nbsp;Connect&nbsp;timeout&nbsp;for&nbsp;requests&nbsp;in&nbsp;seconds,&nbsp;defaults&nbsp;to&nbsp;60s<br>
+:type&nbsp;connect_timeout:&nbsp;int<br>
+:param&nbsp;num_request_retries:&nbsp;Number&nbsp;of&nbsp;retries&nbsp;for&nbsp;failing&nbsp;requests&nbsp;with&nbsp;http&nbsp;status&nbsp;code&nbsp;429,&nbsp;500,&nbsp;502,&nbsp;503&nbsp;or&nbsp;504,<br>
+&nbsp;&nbsp;&nbsp;&nbsp;defaults&nbsp;to&nbsp;60s<br>
+:type&nbsp;num_request_retries:&nbsp;int<br>&nbsp;</tt></td></tr>
+<tr><td>&nbsp;</td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="AICoreV2Client-__init__"><strong>__init__</strong></a>(self, base_url: str, auth_url: str = None, client_id: str = None, client_secret: str = None, cert_str: str = None, key_str: str = None, cert_file_path: str = None, key_file_path: str = None, token_creator: Callable[[], str] = None, resource_group: str = None, read_timeout=60, connect_timeout=60, num_request_retries=3)</dt><dd><tt>Initialize&nbsp;self.&nbsp;&nbsp;See&nbsp;help(type(self))&nbsp;for&nbsp;accurate&nbsp;signature.</tt></dd></dl>
+
+<hr>
+Static methods defined here:<br>
+<dl><dt><a name="AICoreV2Client-from_env"><strong>from_env</strong></a>(profile_name: str = None, **kwargs)</dt><dd><tt>Alternative&nbsp;way&nbsp;to&nbsp;create&nbsp;an&nbsp;<a href="#AICoreV2Client">AICoreV2Client</a>&nbsp;<a href="builtins.html#object">object</a>.<br>
+Parameters&nbsp;for&nbsp;base_url,&nbsp;auth_url,&nbsp;client_id,&nbsp;client_secret,&nbsp;x.509&nbsp;credentials&nbsp;(either&nbsp;as&nbsp;file&nbsp;path&nbsp;or&nbsp;string)<br>
+and&nbsp;resource_group&nbsp;can&nbsp;be&nbsp;passed&nbsp;as&nbsp;keyword&nbsp;or&nbsp;are&nbsp;pulled&nbsp;from&nbsp;environment&nbsp;variables.<br>
+It&nbsp;is&nbsp;also&nbsp;possible&nbsp;to&nbsp;use&nbsp;a&nbsp;profile,&nbsp;which&nbsp;is&nbsp;a&nbsp;json&nbsp;file&nbsp;in&nbsp;the&nbsp;config&nbsp;directory.&nbsp;The&nbsp;profile&nbsp;name&nbsp;can&nbsp;be<br>
+passed&nbsp;as&nbsp;keyword&nbsp;or&nbsp;is&nbsp;pulled&nbsp;from&nbsp;the&nbsp;environment&nbsp;variable&nbsp;AICORE_PROFILE.&nbsp;If&nbsp;no&nbsp;profile&nbsp;is&nbsp;specified,<br>
+the&nbsp;default&nbsp;profile&nbsp;is&nbsp;used.<br>
+A&nbsp;specific&nbsp;path&nbsp;to&nbsp;a&nbsp;config,&nbsp;that&nbsp;should&nbsp;be&nbsp;used,&nbsp;can&nbsp;be&nbsp;set&nbsp;via&nbsp;the&nbsp;environment&nbsp;variable&nbsp;AICORE_CONFIG.<br>
+The&nbsp;hierarchy&nbsp;of&nbsp;precedence&nbsp;is:<br>
+1.&nbsp;keyword&nbsp;argument<br>
+2.&nbsp;environment&nbsp;variable<br>
+3.&nbsp;configuration&nbsp;file<br>
+4.&nbsp;value&nbsp;from&nbsp;VCAP_SERVICES&nbsp;environment&nbsp;variable,&nbsp;if&nbsp;exists<br>
+&nbsp;<br>
+:param&nbsp;profile_name:&nbsp;name&nbsp;of&nbsp;the&nbsp;profile&nbsp;to&nbsp;use,&nbsp;defaults&nbsp;to&nbsp;None.&nbsp;If&nbsp;None&nbsp;is&nbsp;passed,&nbsp;the&nbsp;profile&nbsp;is&nbsp;read&nbsp;from<br>
+&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;environment&nbsp;variable&nbsp;AICORE_PROFILE.&nbsp;If&nbsp;this&nbsp;is&nbsp;not&nbsp;set,&nbsp;the&nbsp;default&nbsp;profile&nbsp;is&nbsp;used.<br>
+&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;default&nbsp;profile&nbsp;is&nbsp;read&nbsp;from&nbsp;$AICORE_HOME/config.json.<br>
+:type&nbsp;profile_name:&nbsp;optional,&nbsp;str<br>
+**kwargs:&nbsp;check&nbsp;the&nbsp;parameters&nbsp;of&nbsp;the&nbsp;class&nbsp;constructor</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>__dict__</strong></dt>
+<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
+</dl>
+<dl><dt><strong>__weakref__</strong></dt>
+<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
+</dl>
+<hr>
+Data and other attributes defined here:<br>
+<dl><dt><strong>logger</strong> = &lt;Logger ai_core_sdk (INFO)&gt;</dl>
+
+</td></tr></table></td></tr></table><p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#55aa55">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
+    
+<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<td width="100%"><strong>Callable</strong> = typing.Callable</td></tr></table>
+</body></html>

sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.cli.html

@@ -0,0 +1,59 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head><title>Python: module ai_core_sdk.cli</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+</head><body bgcolor="#f0f0f8">
+
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
+<tr bgcolor="#7799ee">
+<td valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="ai_core_sdk.html"><font color="#ffffff">ai_core_sdk</font></a>.cli</strong></big></big></font></td
+><td align=right valign=bottom
+><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/cli.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/cli.py</a></font></td></tr></table>
+    <p></p>
+<p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#aa55cc">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
+    
+<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="click.html">click</a><br>
+</td><td width="25%" valign=top><a href="json.html">json</a><br>
+</td><td width="25%" valign=top><a href="pathlib.html">pathlib</a><br>
+</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#eeaa77">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
+    
+<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<td width="100%"><dl><dt><a name="-confirm_resource_group"><strong>confirm_resource_group</strong></a>(resource_group: 'Optional[str]' = None)</dt></dl>
+ <dl><dt><a name="-create_config"><strong>create_config</strong></a>(**kwargs)</dt><dd><tt>#&nbsp;Utility&nbsp;Functions</tt></dd></dl>
+ <dl><dt><a name="-create_config_file"><strong>create_config_file</strong></a>(config_path: 'pathlib.Path', auth_url: 'str', client_id: 'str', client_secret: 'str', cert_file_path: 'pathlib.Path', key_file_path: 'pathlib.Path', base_url: 'str', resource_group: 'str')</dt></dl>
+ <dl><dt><a name="-get_auth_url"><strong>get_auth_url</strong></a>(auth_url: 'Optional[str]' = None)</dt></dl>
+ <dl><dt><a name="-get_base_url"><strong>get_base_url</strong></a>(base_url: 'Optional[str]' = None)</dt></dl>
+ <dl><dt><a name="-get_profile_config_path"><strong>get_profile_config_path</strong></a>(profile: 'str')</dt></dl>
+ <dl><dt><a name="-get_str_value"><strong>get_str_value</strong></a>(msg: 'str', value: 'Optional[str]' = None)</dt></dl>
+ <dl><dt><a name="-is_valid_url"><strong>is_valid_url</strong></a>(url, path_forbidden=True)</dt></dl>
+ <dl><dt><a name="-load_service_key"><strong>load_service_key</strong></a>(service_key_json: 'str')</dt></dl>
+ <dl><dt><a name="-prompt_for_input"><strong>prompt_for_input</strong></a>(prompt_text, is_url=False, path_forbidden=True)</dt></dl>
+</td></tr></table><p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#55aa55">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
+    
+<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<td width="100%"><strong>AI_CORE_PREFIX</strong> = 'AICORE'<br>
+<strong>API_V2_SUFFIX</strong> = '/v2'<br>
+<strong>CREDENTIAL_VALUES</strong> = [CredentialsValue(name='client_id', vcap_key=('cr...s', 'clientid'), default=None, transform_fn=None), CredentialsValue(name='client_secret', vcap_key=...'clientsecret'), default=None, transform_fn=None), CredentialsValue(name='auth_url', vcap_key=('cre...ansform_fn=&lt;function &lt;lambda&gt; at 0x7fadc40fd120&gt;), CredentialsValue(name='base_url', vcap_key=('cre...ansform_fn=&lt;function &lt;lambda&gt; at 0x7fadc40fdc60&gt;), CredentialsValue(name='resource_group', vcap_key=None, default=None, transform_fn=None), CredentialsValue(name='cert_url', vcap_key=('cre...ansform_fn=&lt;function &lt;lambda&gt; at 0x7fadc40fdd80&gt;), CredentialsValue(name='cert_file_path', vcap_key=None, default=None, transform_fn=None), CredentialsValue(name='key_file_path', vcap_key=None, default=None, transform_fn=None), CredentialsValue(name='cert_str', vcap_key=('cre...ansform_fn=&lt;function &lt;lambda&gt; at 0x7fadc40fde10&gt;), CredentialsValue(name='key_str', vcap_key=('cred...ansform_fn=&lt;function &lt;lambda&gt; at 0x7fadc40fdea0&gt;)]<br>
+<strong>DEFAULT_CONFIG</strong> = 'config.json'<br>
+<strong>DEFAULT_PROFILE</strong> = 'default'<br>
+<strong>DEFAULT_RESOURCE_GROUP</strong> = 'default'<br>
+<strong>MAX_TRIES</strong> = 5<br>
+<strong>OAUTH_TOKEN_SUFFIX</strong> = '/oauth/token'<br>
+<strong>Optional</strong> = typing.Optional<br>
+<strong>annotations</strong> = _Feature((3, 7, 0, 'beta', 1), (3, 11, 0, 'alpha', 0), 16777216)<br>
+<strong>cli</strong> = &lt;Group cli&gt;<br>
+<strong>configure</strong> = &lt;Command configure&gt;</td></tr></table>
+</body></html>