XEP-xxxx: Communicate & Ask to AI

Abstract
This document defines a protocol for asking questions to an artificial intelligence or requesting it to make predictions.
Author
Abdurrahman Eker
Copyright
© 2023 – 2023 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <https://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.1 (2023-03-13)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  4. Final

1. Introduction

Using artificial intelligence can be useful for quickly finding documentation or for classification operations that would take a human a long time. This feature enables asking questions to an artificial intelligence and getting guidance from it. It allows fine-tuning the usage limits of the artificial intelligence, making detailed adjustments, and making custom settings for the user.

2. Requirements

When a question is asked to an artificial intelligence, it SHOULD:

  1. Be able to be asked questions and analyze them simultaneously.
  2. Detect parameters and work with the relevant artificial intelligence engine.
  3. Review the limits and permissions of the requester and provide a rejection response if they are not sufficient.

3. Discovery Support

If the client is implementing artificial intelligence messages, it MUST provide the 'urn:xmpp:ai:0' feature in the features section as specified in Service Discovery (XEP-0030) [1] and Entity Capabilities (XEP-0115) [2].

Example 1. Client queries for server features
<iq from='romeo@montague.net/orchard'
    id='disco1'
    to='juliet@capulet.lit'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
Example 2. Server responds with features
<iq to='romeo@montague.net/orchard'
    id='disco1'
    from='juliet@capulet.lit'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
…
    <feature var='urn:xmpp:ai:0'/>
…
  </query>
</iq>

4. Use Cases

4.1 Asking to ai a question

To ask a question to an artificial intelligence, the message package SHOULD be used. This way, the conversation with the artificial intelligence can be recorded and viewed in the message history. The <ai> element MUST be present in the message package, MUST be qualified with the 'urn:xmpp:ai:0' domain, and the model attribute value MUST be entered.

Example 3. A user is asking a question to an artificial intelligence
<message id='1' from='romeo@montague.lit' to='ai@example.com' type='chat'>
  <body>Is love a tender thing?</body>
  <ai xmlns='urn:xmpp:ai:0' model='http://example.ai/model-capulet'/>
</message>
Example 4. The artificial intelligence responds to the user
<message id='2' from='ai@example.com' to='romeo@montague.lit' type='chat'>
  <body>
    Yes, love can be a tender thing. Love is a complex and multi-faceted emotion that can
    manifest in many different ways, but at its core, it often involves a deep feeling of
    affection, care, and tenderness towards another person.
  </body>
  <ai xmlns='urn:xmpp:ai:0' model='http://example.ai/model-capulet'/>
</message>

4.2 Asking to ai with model specific parameters

If an AI model needs to be supported with specific parameters, Data Forms (XEP-0004) [3] can be used. It should be defined within the <message> element with the 'jabber:x:data' namespace.

Example 5. The user sends custom parameters to the AI for a short response.
<message id='3' from='romeo@montague.lit' to='ai@example.com' type='chat'>
  <body>Is love a tender thing?</body>
  <ai xmlns='urn:xmpp:ai:0' model='http://example.ai/model-capulet'/>
  <x xmlns='jabber:x:data' type='submit'>
    <field type='hidden' var='FORM_TYPE'>
      <value>urn:xmpp:ai:0</value>
    </field>
    <field var='max_word' type='text-single'>
      <value>10</value>
    </field>
  </x>
</message>
Example 6. The AI returns a specific result to the user based on the parameters sent.
<message id='4' from='ai@example.com' to='romeo@montague.lit' type='chat'>
  <body>Yes, love can be a tender thing.</body>
  <ai xmlns='urn:xmpp:ai:0' model='http://example.ai/model-capulet'/>
  <x xmlns='jabber:x:data' type='result'>
    <field type='hidden' var='FORM_TYPE'>
      <value>urn:xmpp:ai:0</value>
    </field>
    <field var='max_word' type='text-single'>
      <value>10</value>
    </field>
  </x>
</message>

4.3 Asking artificial intelligence to make predictions based on a past conversation

The desired speech must be sent to the artificial intelligence to estimate the next message. To predict the next message, the past conversation MUST be sent to the AI using the <suggest> element inside the <ai> element, along with the message archive history Message Archive Management (XEP-0313) [4].

Example 7. The user sends local messages to AI for a suggestion.
<message id='5' from='romeo@montague.lit' to='ai@example.com' type='chat'>
  <body>What should I say?</body>
  <ai xmlns='urn:xmpp:ai:0' model='http://example.ai/model-capulet'>
    <suggest xmlns='urn:xmpp:ai:0'>
      <forwarded xmlns='urn:xmpp:forward:0'>
        <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
        <message xmlns='jabber:client' from='juliet@capulet.lit' to='romeo@montague.lit'>
          <body>Romeo!</body>
        </message>
      </forwarded>
      <forwarded xmlns='urn:xmpp:forward:0'>
        <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:28Z'/>
        <message xmlns='jabber:client' from='romeo@montague.lit' to='juliet@capulet.lit'>
          <body>My dear?</body>
        </message>
      </forwarded>
      <forwarded xmlns='urn:xmpp:forward:0'>
        <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:30Z'/>
        <message xmlns='jabber:client' from='juliet@capulet.lit' to='romeo@montague.lit'>
          <body>
            At what o'clock to-morrow
            Shall I send to thee?
          </body>
        </message>
      </forwarded>
    </suggest>
  </ai>
</message>
Example 8. The AI returns a suggestion
<message id='6' from='ai@example.com' to='romeo@montague.lit' type='chat'>
  <body>At the hour of nine.</body>
  <ai xmlns='urn:xmpp:ai:0' model='http://example.ai/model-capulet'>
    <suggest xmlns='urn:xmpp:ai:0'>
      <forwarded xmlns='urn:xmpp:forward:0'>
        <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
        <message xmlns='jabber:client' from='juliet@capulet.lit' to='romeo@montague.lit'>
          <body>Romeo!</body>
        </message>
      </forwarded>
      <forwarded xmlns='urn:xmpp:forward:0'>
        <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:28Z'/>
        <message xmlns='jabber:client' from='romeo@montague.lit' to='juliet@capulet.lit'>
          <body>My dear?</body>
        </message>
      </forwarded>
      <forwarded xmlns='urn:xmpp:forward:0'>
        <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:30Z'/>
        <message xmlns='jabber:client' from='juliet@capulet.lit' to='romeo@montague.lit'>
          <body>
            At what o'clock to-morrow
            Shall I send to thee?
          </body>
        </message>
      </forwarded>
    </suggest>
  </ai>
</message>

5. Business Rules

5.1 General

5.2 User Interface

  1. The messaging app should provide a clear indication that the suggested messages are generated by an AI service, and provide an option for the user to opt-out of the feature.
  2. The suggested messages should be presented in a way that distinguishes them from the user's own messages, and allows the user to edit or customize them before sending.
  3. The user interface should provide a way for the user to provide feedback on the suggested messages, such as rating them or reporting inappropriate suggestions.

6. Implementation Notes

There is no implementation to make the AI have a default setting and return a response from that setting.

7. Accessibility Considerations

The value returned by artificial intelligence consists entirely of text. Returned text can be accessed using voice-over technologies.

8. Security Considerations

Determining when an AI question can be executed based on permissions or rights is considered outside the scope of this document. Although such mechanisms are considered specific to the application and/or implementation of this document, future specifications may address these concerns.

When processing reported AI questions, the requester SHOULD consider any question node that does not match the JID of the responder to be suspicious, and ignore those AI questions nodes. Responders MUST report their own AI question nodes only, and not the AI question nodes of other entities. This can help prevent limited cases of spoofing and "social engineering".

9. IANA Considerations

This document requires no interaction with the the Internet Assigned Numbers Authority (IANA) [5].

10. XMPP Registrar Considerations

10.1 Protocol Namespaces

This specification defines the following XML namespace:

Upon advancement of this specification from a status of Experimental to a status of Draft, the XMPP Registrar [6] shall add the foregoing namespace to the registry located at <https://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function (XEP-0053) [7].

10.2 Protocol Versioning

If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.

11. Design Considerations

The results of artificial intelligence have not been put into any classification. In addition to the response it returns, Data Forms (XEP-0004) [3] can be used to specify which parameters it obtained this different result from.

12. XML Schema

REQUIRED for protocol specifications.

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:ai:0'
    xmlns='urn:xmpp:ai:0'
    xmlns:forward='urn:xmpp:forward:0'
    elementFormDefault='qualified'>

  <xs:annotation>
    <xs:documentation>
      The protocol documented by this schema is defined in
      XEP-xxxx: http://www.xmpp.org/extensions/xep-xxxx.html
    </xs:documentation>
  </xs:annotation>

  <xs:import namespace='urn:xmpp:forward:0'
             schemaLocation='http://xmpp.org/schemas/forward.xsd'/>

  <xs:element name='ai'>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="suggest" minOccurs="0" maxOccurs="1">
          <xs:complexType>
            <xs:sequence>
              <xs:element minOccurs="1" ref="forward:forwarded"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
      <xs:attribute name='model' type='xs:string' use='required'/>
    </xs:complexType>
  </xs:element>
</xs:schema>

Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.1
Last Updated
2023-03-13
Approving Body
XMPP Council
Dependencies
XMPP Core, XEP-0001, Etc.
Supersedes
None
Superseded By
None
Short Name
NOT_YET_ASSIGNED

This document in other formats: XML  PDF

Appendix B: Author Information

Abdurrahman Eker
Email
abdurrahman.eker@detaysoft.com
JabberID
abdurrahman.eker@detaysoft.com

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

1. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.

2. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.

3. XEP-0004: Data Forms <https://xmpp.org/extensions/xep-0004.html>.

4. XEP-0313: Message Archive Management <https://xmpp.org/extensions/xep-0313.html>.

5. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

6. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.

7. XEP-0053: XMPP Registrar Function <https://xmpp.org/extensions/xep-0053.html>.

Appendix H: Revision History

Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/

  1. Version 0.0.1 (2023-03-13)

    First draft.

    ae

Appendix I: Bib(La)TeX Entry

@report{eker2023xepxxxx,
  title = {Communicate & Ask to AI},
  author = {Eker, Abdurrahman},
  type = {XEP},
  number = {xxxx},
  version = {0.0.1},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-xxxx.html},
  date = {2023-03-13/2023-03-13},
}

END