Class: Twilio::REST::Assistants::V1::KnowledgeList::AssistantsV1ServiceCreateKnowledgeRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/twilio-ruby/rest/assistants/v1/knowledge.rb,
lib/twilio-ruby/rest/assistants/v1/knowledge.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payload) ⇒ AssistantsV1ServiceCreateKnowledgeRequest

Returns a new instance of AssistantsV1ServiceCreateKnowledgeRequest.



31
32
33
34
35
36
37
38
39
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 31

def initialize(payload)
        @assistant_id = payload["assistant_id"]
        @description = payload["description"]
        @knowledge_source_details = payload["knowledge_source_details"]
        @name = payload["name"]
        @policy = payload["policy"]
        @type = payload["type"]
        @embedding_model = payload["embedding_model"]
end

Instance Attribute Details

#assistant_id ⇒ Object

Parameters:

  • : (assistant_id) —
    String

    The Assistant ID.

  • : (description) —
    String

    The description of the knowledge source.

  • : (knowledge_source_details) —
    Hash

    The details of the knowledge source based on the type.

  • : (name) —
    String

    The name of the tool.

  • : (policy) —
    KnowledgeList.AssistantsV1ServiceCreatePolicyRequest
  • : (type) —
    String

    The type of the knowledge source.

  • : (embedding_model) —
    String

    The embedding model to be used for the knowledge source. It’s required for ‘Database’ type but disallowed for other types.



30
31
32
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 30

def assistant_id
  @assistant_id
end

#description ⇒ Object

Parameters:

  • : (assistant_id) —
    String

    The Assistant ID.

  • : (description) —
    String

    The description of the knowledge source.

  • : (knowledge_source_details) —
    Hash

    The details of the knowledge source based on the type.

  • : (name) —
    String

    The name of the tool.

  • : (policy) —
    KnowledgeList.AssistantsV1ServiceCreatePolicyRequest
  • : (type) —
    String

    The type of the knowledge source.

  • : (embedding_model) —
    String

    The embedding model to be used for the knowledge source. It’s required for ‘Database’ type but disallowed for other types.



30
31
32
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 30

def description
  @description
end

#embedding_model ⇒ Object

Parameters:

  • : (assistant_id) —
    String

    The Assistant ID.

  • : (description) —
    String

    The description of the knowledge source.

  • : (knowledge_source_details) —
    Hash

    The details of the knowledge source based on the type.

  • : (name) —
    String

    The name of the tool.

  • : (policy) —
    KnowledgeList.AssistantsV1ServiceCreatePolicyRequest
  • : (type) —
    String

    The type of the knowledge source.

  • : (embedding_model) —
    String

    The embedding model to be used for the knowledge source. It’s required for ‘Database’ type but disallowed for other types.



30
31
32
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 30

def embedding_model
  @embedding_model
end

#knowledge_source_details ⇒ Object

Parameters:

  • : (assistant_id) —
    String

    The Assistant ID.

  • : (description) —
    String

    The description of the knowledge source.

  • : (knowledge_source_details) —
    Hash

    The details of the knowledge source based on the type.

  • : (name) —
    String

    The name of the tool.

  • : (policy) —
    KnowledgeList.AssistantsV1ServiceCreatePolicyRequest
  • : (type) —
    String

    The type of the knowledge source.

  • : (embedding_model) —
    String

    The embedding model to be used for the knowledge source. It’s required for ‘Database’ type but disallowed for other types.



30
31
32
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 30

def knowledge_source_details
  @knowledge_source_details
end

#name ⇒ Object

Parameters:

  • : (assistant_id) —
    String

    The Assistant ID.

  • : (description) —
    String

    The description of the knowledge source.

  • : (knowledge_source_details) —
    Hash

    The details of the knowledge source based on the type.

  • : (name) —
    String

    The name of the tool.

  • : (policy) —
    KnowledgeList.AssistantsV1ServiceCreatePolicyRequest
  • : (type) —
    String

    The type of the knowledge source.

  • : (embedding_model) —
    String

    The embedding model to be used for the knowledge source. It’s required for ‘Database’ type but disallowed for other types.



30
31
32
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 30

def name
  @name
end

#policy ⇒ Object

Parameters:

  • : (assistant_id) —
    String

    The Assistant ID.

  • : (description) —
    String

    The description of the knowledge source.

  • : (knowledge_source_details) —
    Hash

    The details of the knowledge source based on the type.

  • : (name) —
    String

    The name of the tool.

  • : (policy) —
    KnowledgeList.AssistantsV1ServiceCreatePolicyRequest
  • : (type) —
    String

    The type of the knowledge source.

  • : (embedding_model) —
    String

    The embedding model to be used for the knowledge source. It’s required for ‘Database’ type but disallowed for other types.



30
31
32
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 30

def policy
  @policy
end

#type ⇒ Object

Parameters:

  • : (assistant_id) —
    String

    The Assistant ID.

  • : (description) —
    String

    The description of the knowledge source.

  • : (knowledge_source_details) —
    Hash

    The details of the knowledge source based on the type.

  • : (name) —
    String

    The name of the tool.

  • : (policy) —
    KnowledgeList.AssistantsV1ServiceCreatePolicyRequest
  • : (type) —
    String

    The type of the knowledge source.

  • : (embedding_model) —
    String

    The embedding model to be used for the knowledge source. It’s required for ‘Database’ type but disallowed for other types.



30
31
32
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 30

def type
  @type
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 40

def to_json(options = {})
{
        "assistant_id": @assistant_id,
        "description": @description,
        "knowledge_source_details": @knowledge_source_details,
        "name": @name,
        "policy": @policy,
        "type": @type,
        "embedding_model": @embedding_model,
}.to_json(options)
end