Class: LiteLLMClient::VectorStoreManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/api/vector_store_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VectorStoreManagementApi

Returns a new instance of VectorStoreManagementApi.



19
20
21
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_vector_store_vector_store_delete_post(vector_store_delete_request, opts = {}) ⇒ Object

Delete Vector Store Delete a vector store. Parameters: - vector_store_id: str - ID of the vector store to delete

Parameters:

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 27

def delete_vector_store_vector_store_delete_post(vector_store_delete_request, opts = {})
  data, _status_code, _headers = delete_vector_store_vector_store_delete_post_with_http_info(vector_store_delete_request, opts)
  data
end

#delete_vector_store_vector_store_delete_post_with_http_info(vector_store_delete_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Vector Store Delete a vector store. Parameters: - vector_store_id: str - ID of the vector store to delete

Parameters:

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 37

def delete_vector_store_vector_store_delete_post_with_http_info(vector_store_delete_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VectorStoreManagementApi.delete_vector_store_vector_store_delete_post ...'
  end
  # verify the required parameter 'vector_store_delete_request' is set
  if @api_client.config.client_side_validation && vector_store_delete_request.nil?
    fail ArgumentError, "Missing the required parameter 'vector_store_delete_request' when calling VectorStoreManagementApi.delete_vector_store_vector_store_delete_post"
  end
  # resource path
  local_var_path = '/vector_store/delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(vector_store_delete_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"VectorStoreManagementApi.delete_vector_store_vector_store_delete_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VectorStoreManagementApi#delete_vector_store_vector_store_delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_vector_stores_vector_store_list_get(opts = {}) ⇒ LiteLLMManagedVectorStoreListResponse

List Vector Stores List all available vector stores with optional filtering and pagination. Combines both in-memory vector stores and those stored in the database. Parameters: - page: int - Page number for pagination (default: 1) - page_size: int - Number of items per page (default: 100)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 100

Returns:



96
97
98
99
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 96

def list_vector_stores_vector_store_list_get(opts = {})
  data, _status_code, _headers = list_vector_stores_vector_store_list_get_with_http_info(opts)
  data
end

#list_vector_stores_vector_store_list_get_with_http_info(opts = {}) ⇒ Array<(LiteLLMManagedVectorStoreListResponse, Integer, Hash)>

List Vector Stores List all available vector stores with optional filtering and pagination. Combines both in-memory vector stores and those stored in the database. Parameters: - page: int - Page number for pagination (default: 1) - page_size: int - Number of items per page (default: 100)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 100

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 107

def list_vector_stores_vector_store_list_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VectorStoreManagementApi.list_vector_stores_vector_store_list_get ...'
  end
  # resource path
  local_var_path = '/vector_store/list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LiteLLMManagedVectorStoreListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"VectorStoreManagementApi.list_vector_stores_vector_store_list_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VectorStoreManagementApi#list_vector_stores_vector_store_list_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#new_vector_store_vector_store_new_post(lite_llm_managed_vector_store, opts = {}) ⇒ Object

New Vector Store Create a new vector store. Parameters: - vector_store_id: str - Unique identifier for the vector store - custom_llm_provider: str - Provider of the vector store - vector_store_name: Optional - Name of the vector store - vector_store_description: Optional - Description of the vector store - vector_store_metadata: Optional - Additional metadata for the vector store

Parameters:

Returns:

  • (Object) 


158
159
160
161
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 158

def new_vector_store_vector_store_new_post(lite_llm_managed_vector_store, opts = {})
  data, _status_code, _headers = new_vector_store_vector_store_new_post_with_http_info(lite_llm_managed_vector_store, opts)
  data
end

#new_vector_store_vector_store_new_post_with_http_info(lite_llm_managed_vector_store, opts = {}) ⇒ Array<(Object, Integer, Hash)>

New Vector Store Create a new vector store. Parameters: - vector_store_id: str - Unique identifier for the vector store - custom_llm_provider: str - Provider of the vector store - vector_store_name: Optional - Name of the vector store - vector_store_description: Optional - Description of the vector store - vector_store_metadata: Optional - Additional metadata for the vector store

Parameters:

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/litellm_client/api/vector_store_management_api.rb', line 168

def new_vector_store_vector_store_new_post_with_http_info(lite_llm_managed_vector_store, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VectorStoreManagementApi.new_vector_store_vector_store_new_post ...'
  end
  # verify the required parameter 'lite_llm_managed_vector_store' is set
  if @api_client.config.client_side_validation && lite_llm_managed_vector_store.nil?
    fail ArgumentError, "Missing the required parameter 'lite_llm_managed_vector_store' when calling VectorStoreManagementApi.new_vector_store_vector_store_new_post"
  end
  # resource path
  local_var_path = '/vector_store/new'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(lite_llm_managed_vector_store)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"VectorStoreManagementApi.new_vector_store_vector_store_new_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VectorStoreManagementApi#new_vector_store_vector_store_new_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end